From 43f7f37d93365dee709c1f54286d9f21ca546eab Mon Sep 17 00:00:00 2001 From: Yuri Kunde Schlesner Date: Thu, 4 Dec 2014 04:47:52 -0200 Subject: [PATCH] Resolve doxycomment duplication debate 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. --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 82b66be75..c8c8e3884 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,6 +27,7 @@ Follow the indentation/whitespace style shown below. Do not use tabs, use 4-spac ### Comments * 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 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 namespace Example {