Editing C++ style guide

Jump to navigation Jump to search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Latest revision Your text
Line 181: Line 181:
 
=== std::string ===
 
=== std::string ===
  
When an empty string is required, use "", rather than creating an empty
+
When an empty string is required, use @qcode{""}, rather than creating an empty
string object with std::string ().
+
string object with @code{std::string ()}.
  
 
=== auto ===
 
=== auto ===
Line 225: Line 225:
 
* Use as little formatting as possible.  Restrict to [https://www.stack.nl/~dimitri/doxygen/manual/markdown.html Markdown] and avoid HTML-markup.
 
* Use as little formatting as possible.  Restrict to [https://www.stack.nl/~dimitri/doxygen/manual/markdown.html Markdown] and avoid HTML-markup.
 
* Do NOT use the {{codeline|@brief}} command, the first sentence will automatically be used as the summary description.
 
* Do NOT use the {{codeline|@brief}} command, the first sentence will automatically be used as the summary description.
* The first sentence should describe briefly what the function does and end with a period.
+
* The first sentence should describe briefly what the function does and and with a period.
 
* Leave a blank line between the Doxygen comment and function definition.
 
* Leave a blank line between the Doxygen comment and function definition.
  

Please note that all contributions to Octave may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see Octave:Copyrights for details). Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel Editing help (opens in new window)

Templates used on this page: