Coding Convention
This page describes some common coding convention that you'll see in lisp source code.

Use a different number of semicolons for a comment to provide information on the comment. See the Tips on Writing Comments section from the Elisp manual for examples.

  • Use a single semicolon when commenting on code on the same line
  • Use two semicolons when commenting on code on the next line
  • Use three semicolons when commenting on the following block of code
  • Use four semicolons when commenting on the next section of code

Avoid using tabs. Put (setq indent-tabs-mode nil) in ~/.emacs to replace tabs with spaces.

Additional Resources