add a note about inline comments
authorRussell Bryant <russell@russellbryant.com>
Tue, 5 Jun 2007 14:59:34 +0000 (14:59 +0000)
committerRussell Bryant <russell@russellbryant.com>
Tue, 5 Jun 2007 14:59:34 +0000 (14:59 +0000)
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@67273 65c4cc65-6c06-0410-ace0-fbb531ad65f3

doc/CODING-GUIDELINES

index ce6b80e..990f5bc 100644 (file)
@@ -484,6 +484,14 @@ Note that /*! */ blocks document the construct immediately following them
 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
 ------------------------------------------