be explicit about making comments real sentences.
authorChris Lattner <sabre@nondot.org>
Sun, 12 Jul 2009 00:10:24 +0000 (00:10 +0000)
committerChris Lattner <sabre@nondot.org>
Sun, 12 Jul 2009 00:10:24 +0000 (00:10 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@75406 91177308-0d34-0410-b5e6-96231b3b80d8

docs/CodingStandards.html

index dbe95a8d58815e0c14b1ed1cbac9218719820d46..79c816ef65f3fbfc3add9b5f70bbc3f35d34fab2 100644 (file)
@@ -118,7 +118,9 @@ href="mailto:sabre@nondot.org">Chris</a>.</p>
 <div class="doc_text">
 
 <p>Comments are one critical part of readability and maintainability.  Everyone
-knows they should comment, so should you.  Although we all should probably
+knows they should comment, so should you.  When writing comments, write them as
+English prose, which means they should use proper capitalization, punctuation,
+etc.  Although we all should probably
 comment our code more than we do, there are a few very critical places that
 documentation is very useful:</p>