[svn-commits] russell: trunk r67273 - /trunk/doc/CODING-GUIDELINES

[svn-commits at lists.digium.com]

Author: russell
Date: Tue Jun  5 09:59:34 2007
New Revision: 67273

URL: http://svn.digium.com/view/asterisk?view=rev&rev=67273
Log:
add a note about inline comments

Modified:
    trunk/doc/CODING-GUIDELINES

Modified: trunk/doc/CODING-GUIDELINES
URL: http://svn.digium.com/view/asterisk/trunk/doc/CODING-GUIDELINES?view=diff&rev=67273&r1=67272&r2=67273
==============================================================================
--- trunk/doc/CODING-GUIDELINES (original)
+++ trunk/doc/CODING-GUIDELINES Tue Jun  5 09:59:34 2007
@@ -484,6 +484,14 @@
 unless they are written, /*!< */, in which case they document the construct
 preceding them.
 
+It is very much preferred that documentation is not done inline, as done in
+the previous example for member2.  The first reason for this is that it tends
+to encourage extremely brief, and often pointless, documentation since people
+try to keep the comment from making the line extremely long.  However, if you
+insist on using inline comments, please indent the documentation with spaces!
+That way, all of the comments are properly aligned, regardless of what tab
+size is being used for viewing the code.
+
 * Finishing up before you submit your code
 ------------------------------------------