We recommend these conventions for comments:
(setq base-version-list ; there was a base (assoc (substring fn 0 start-vn) ; version to which file-version-assoc-list)) ; this looks like ; a subversion
(prog1 (setq auto-fill-function ... ... ;; Update mode line. (force-mode-line-update)))
We also normally use two semicolons for comments outside functions.
;; This Lisp code is run in Emacs when it is to operate as ;; a server for other processes.
If a function has no documentation string, it should instead have a
two-semicolon comment right before the function, explaining what the
function does and how to call it properly. Explain precisely what
each argument means and how the function interprets its possible
values. It is much better to convert such comments to documentation
Another use for triple-semicolon comments is for commenting out lines within a function. We use three semicolons for this precisely so that they remain at the left margin. By default, Outline minor mode does not consider a comment to be a heading (even if it starts with at least three semicolons) if the semicolons are followed by at least two spaces. Thus, if you add an introductory comment to the commented out code, make sure to indent it by at least two spaces after the three semicolons.
(defun foo (a) ;;; This is no longer necessary. ;;; (force-mode-line-update) (message "Finished with %s" a))
When commenting out entire functions, use two semicolons.
;;;; The kill ring
Generally speaking, the M-; (
automatically starts a comment of the appropriate type; or indents an
existing comment to the right place, depending on the number of
See Manipulating Comments.