maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

be explicit about making comments real sentences. 

llvm-svn: 75406
This commit is contained in:
Chris Lattner 2009-07-12 00:10:24 +00:00
parent d57fb023e0
commit bbe228ba10
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
llvm/docs/CodingStandards.html
View 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>