comment formatting

gistfile1.lisp

;;;      1         2         3         4         5         6         0
;;;456789012345678901234567890123456789012345678901234567890123456789012345678

;;;12345678         1         2         3         4         5         6
;;;        123456789012345678901234567890123456789012345678901234567890123456.
;;;
;;;        This document is intended to show better comment formatting. It
;;;        allows for 66 characters of main body text, with an 8-space margin
;;;        to the left, and a one-space margin to the right, while fitting
;;;        within 78 columns.
;;;     *  Bullets have three spaces to the left and two spaces to the right,
;;;        pushing them into the margin.
;;;     1  numbered lists are the same, but if they go above nine, the stay
;;;        right-aligned,
;;;     2  let's pretend there are some intervening items ...
;;;    10  hopefully you don't have more than 99999 items in your list.
;;;    11 "the double space before the content allows for hanging punctuation,
;;;        which is also permissable at the end of the line, and also serves
;;;        to separate the numbers from the content without additional
;;;        punctuation."
;;;
;;;  NOTE: The traditional asides can also squeeze into the margin
;;;  TODO: find a good example for here
;;; FIXME:"Is it permissible to disappear the space between the colon and
;;;        punctuation?"
;;;  TODO: We could replace `NOTE:`, `TODO:`, and `FIXME:` with `???`, `###`,
;;;        and `!!!`, respectively; eliminating two columns to the left and
;;;        providing an extra level of indentation


;;;123456         1         2         3         4         5         6
;;;      123456789012345678901234567890123456789012345678901234567890123456...
;;;
;;;      This document is intended to show better comment formatting. It
;;;      allows for 66 characters of main body text, with a 6-space margin
;;;      to the left, and a three-space margin to the right, while fitting
;;;      within 78 columns.
;;;   *  Bullets have three spaces to the left and two spaces to the right,
;;;      pushing them into the margin.
;;;   1  numbered lists are the same, but if they go above nine, the stay
;;;      right-aligned,
;;;   2  let's pretend there are some intervening items ...
;;;  10  hopefully you don't have more than 99999 items in your list.
;;;  11 "the double space before the content allows for hanging punctuation,
;;;      which is also permissable at the end of the line, and also serves
;;;      to separate the numbers from the content without additional
;;;      punctuation."
;;;
;;; ###  The traditional asides can also squeeze into the margin
;;; ???  find a good example for here
;;; !!! "Is it permissible to disappear the space between the colon and
;;;      punctuation?"
;;; ???  We could replace `NOTE:`, `TODO:`, and `FIXME:` with `###`, `???`,
;;;      and `!!!`, respectively; eliminating two columns to the left and
;;;      providing an extra level of indentation


    ;;      After a couple levels of indentation, you have to give up hanging
    ;;      punctuation in the right margin.
    ;;
    ;;123456         1         2         3         4         5         6
    ;;      123456789012345678901234567890123456789012345678901234567890123456

      ;;      Then you start having to narrow the width of the body text to
      ;;      avoid going beyond column 78.
      ;;
      ;;123456         1         2         3         4         5         6
      ;;      1234567890123456789012345678901234567890123456789012345678901234

                                        ; EOL comments, however, just need a
                                        ; 1-space left margin, since they
                                        ; should be fairly short.

                                        ; ### "If there is comment prefix,
                                        ;      additional lines should be
                                        ;      indented appropriately.