diff --git a/docs/CodingStandards.html b/docs/CodingStandards.html index dbe95a8d588..79c816ef65f 100644 --- a/docs/CodingStandards.html +++ b/docs/CodingStandards.html @@ -118,7 +118,9 @@ href="mailto:sabre@nondot.org">Chris.

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: