bbatsov / emacs-lisp-style-guide

A community-driven Emacs Lisp style guide
1.08k stars 53 forks source link

;;; is for headings only #9

Closed tarsius closed 10 years ago

tarsius commented 10 years ago

In Emacs Lisp by convention three or more semicolons are treated as headings.

From (elisp)Comment Tips

`;;;'
     Comments that start with three semicolons, `;;;', should start at
     the left margin.  We use them for comments which should be
     considered a "heading" by Outline minor mode.  By default,
     comments starting with at least three semicolons (followed by a
     single space and a non-whitespace character) are considered
     headings, comments starting with two or fewer are not.
     Historically, triple-semicolon comments have also been used for
     commenting out lines within a function, but this use is
     discouraged.

     When commenting out entire functions, use two semicolons.

outline-minor-mode and others use this like this.

;;; heading
;;;; subheading
;;;;; subsubheading
;;;;;; and so on

;; comment
;; continued
(code)
Malabarba commented 10 years ago

Might this be the same as #2?

tarsius commented 10 years ago

Ups sorry.