1,072
edits
C++ style guide: Difference between revisions
Jump to navigation
Jump to search
m
Re-wording
(→Doxygen Style Guide: more Doxygen style recommendations) |
m (Re-wording) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 181: | Line 181: | ||
=== std::string === | === std::string === | ||
When an empty string is required, use | When an empty string is required, use "", rather than creating an empty | ||
string object with | string object with 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 | * The first sentence should describe briefly what the function does and end 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. | ||