[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Conventions for writing comments

From: Sebastien Vauban
Subject: Conventions for writing comments
Date: Mon, 06 Oct 2014 11:20:11 +0200
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/24.3.94 (windows-nt)


I have a small question about conventions for writing comments... Can
I consider the following to be the rule?

- If it's a *sentence* (like ";; Search for the first instance", in the
  imperative form), comments must begin with a capital and end with a dot.
- Otherwise (like ";; pattern found"), comments must begin with a small
  letter and don't end with a dot.


Tips on writing comments found on
aren't very helpful regarding my question, as you see things such as:

- "; there was there was a base version to which this looks like
  a subversion", that is a sentence with no capital nor dot...

- ";; Update mode line.", that is a sentence with both beginning capital
  and to.

- ";;;; The kill ring", an expression with a capital...

Though, that page seems to be more on the usage of ";", ";;", ";;;" and
";;;;" than on the usage of capitals and dots.

Best regards,

Sebastien Vauban

reply via email to

[Prev in Thread] Current Thread [Next in Thread]