flodavid/suyu
1
0
Fork 0
forked from suyu/suyu
Code Pull requests Activity

Resolve doxycomment duplication debate

Browse source 
I believe putting comments in the headers has won by a good margin, with everyone other than me preferring it, so time to enshrine it.
This commit is contained in:
Yuri Kunde Schlesner 2014-12-04 04:47:52 -02:00
parent 846dc72a37
commit 43f7f37d93
1 changed files with 1 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
CONTRIBUTING.md
View file

@ -27,6 +27,7 @@ Follow the indentation/whitespace style shown below. Do not use tabs, use 4-spac
### Comments ### Comments
* For regular comments, use C++ style (`//`) comments, even for multi-line ones. * For regular comments, use C++ style (`//`) comments, even for multi-line ones.
* For doc-comments (Doxygen comments), use `/// ` if it's a single line, else use the `/**` `*/` style featured in the example. Start the text on the second line, not the first containing `/**`. * For doc-comments (Doxygen comments), use `/// ` if it's a single line, else use the `/**` `*/` style featured in the example. Start the text on the second line, not the first containing `/**`.
* For items that are both defined and declared in two separate files, put the doc-comment only next to the associated declaration. (In a header file, usually.) Otherwise, put it next to the implementation. Never duplicate doc-comments in both places.
```cpp ```cpp
namespace Example { namespace Example {