From b927ca813bd1b9a96b6ac14c5b57a76d4b73726a Mon Sep 17 00:00:00 2001 From: Chris Lattner Date: Sun, 12 Jul 2009 00:10:24 +0000 Subject: [PATCH] be explicit about making comments real sentences. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@75406 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/CodingStandards.html | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) 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: