emacs: Comments

 
 26.5 Manipulating Comments
 ==========================
 
 Because comments are such an important part of programming, Emacs
 provides special commands for editing and inserting comments.  It can
 also do spell checking on comments with Flyspell Prog mode (See
 Spelling).
 
    Some major modes have special rules for indenting different kinds of
 comments.  For example, in Lisp code, comments starting with two
 semicolons are indented as if they were lines of code, while those
 starting with three semicolons are supposed to be aligned to the left
 margin and are often used for sectioning purposes.  Emacs understand
 these conventions; for instance, typing <TAB> on a comment line will
 indent the comment to the appropriate position.
 
      ;; This function is just an example.
      ;;; Here either two or three semicolons are appropriate.
      (defun foo (x)
      ;;;  And now, the first part of the function:
        ;; The following line adds one.
        (1+ x))           ; This line adds one.
 

Menu