RPCSX/llvm
1
0
Fork 0
mirror of https://github.com/RPCSX/llvm.git synced 2024-11-25 12:50:00 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

be explicit about making comments real sentences.

Browse Source 
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@75406 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Chris Lattner 2009-07-12 00:10:24 +00:00
parent f5c21ecfa6
commit b927ca813b
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
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>