diff options
| author | Chris Lattner <sabre@nondot.org> | 2009-07-12 00:10:24 +0000 |
|---|---|---|
| committer | Chris Lattner <sabre@nondot.org> | 2009-07-12 00:10:24 +0000 |
| commit | bbe228ba106ab36e5ec6944334cde0cf405a063a (patch) | |
| tree | a3cd8eeffdb84db4f213f7a18c74f8c3c4bc7759 /llvm/docs/CodingStandards.html | |
| parent | d57fb023e08c76829cfd044d6ad0eee2edb9e484 (diff) | |
| download | bcm5719-llvm-bbe228ba106ab36e5ec6944334cde0cf405a063a.tar.gz bcm5719-llvm-bbe228ba106ab36e5ec6944334cde0cf405a063a.zip | |
be explicit about making comments real sentences.
llvm-svn: 75406
Diffstat (limited to 'llvm/docs/CodingStandards.html')
| -rw-r--r-- | llvm/docs/CodingStandards.html | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/llvm/docs/CodingStandards.html b/llvm/docs/CodingStandards.html index dbe95a8d588..79c816ef65f 100644 --- a/llvm/docs/CodingStandards.html +++ b/llvm/docs/CodingStandards.html @@ -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> |
