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 | b927ca813bd1b9a96b6ac14c5b57a76d4b73726a (patch) | |
| tree | 23baa2ded4e5890322cc16e346715499766c3912 /docs/CodingStandards.html | |
| parent | f5c21ecfa6ff0b9bdd818e8b3457b239bfd0c271 (diff) | |
| download | external_llvm-b927ca813bd1b9a96b6ac14c5b57a76d4b73726a.zip external_llvm-b927ca813bd1b9a96b6ac14c5b57a76d4b73726a.tar.gz external_llvm-b927ca813bd1b9a96b6ac14c5b57a76d4b73726a.tar.bz2 | |
be explicit about making comments real sentences.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@75406 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/CodingStandards.html')
| -rw-r--r-- | docs/CodingStandards.html | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/CodingStandards.html b/docs/CodingStandards.html index dbe95a8..79c816e 100644 --- a/docs/CodingStandards.html +++ b/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> |