Convención de comentarios de Lisp

En Common Lisp:

;;;; At the top of source files

;;; Comments at the beginning of the line

(defun test (a &optional b)
  ;; Commends indented along with code
  (do-something a)                      ; Comments indented at column 40, or the last
  (do-something-else b))                ; column + 1 space if line exceeds 38 columns

Nota: Emacs no fontifica #| |# muy bien, pero como Rainer sugiere en los comentarios, intente usar #|| ||# en su lugar.

Yo diría que no hay reglas para usar esta, pero creo que es más rápido para comentar grandes cantidades de código, o para insertar alguna descripción larga donde los puntos y comas solo se interponen en el camino de la edición, como enormes listados BNF o similares.

Hay un buen truco para desactivar el código que es prefijar una expresión con #+(or):

(defun test (a &optional b)
  #+(or)
  (do-something a)
  (do-something-else b))

Nota: #+nil generalmente funciona también, a menos que tenga una característica nil o :nil. La ventaja de #+(or) es que puede editarlo fácilmente comentándolo o cambiándolo a #+(and), o incluir realmente un conjunto de características sobre las que realmente desea que se lea esa expresión.

SLIME ayuda aquí al fontificar el formulario (do-something a) como un comentario cuando se tiene un Lisp en ejecución.

Aparte de la particular sintaxis de comentarios y trucos de Common Lisp, como #| |# y #+(or) o las más comúnmente vistas #+nil, creo que las reglas de punto y coma también se adoptan ampliamente en otros lisps.

Aquí hay un extracto de la especificación , observe cómo la práctica actual ha divergido con respecto al punto y coma único:

2.4.4.2 Notas sobre el estilo para Punto y coma

Algunos editores de texto hacen suposiciones sobre la sangría deseada basándose en el número de puntos y comas que comienzan un comentario. Las siguientes convenciones de estilo son comunes, aunque de ninguna manera universales.

2.4.4.2.1 Uso de un punto y coma

Los comentarios que comienzan con un solo punto y coma están todos alineados a la misma columna a la derecha (a veces llamada "columna de comentarios"). El texto de tal comentario se aplica generalmente sólo a la línea en la que aparece. De vez en cuando dos o tres contienen una sola oración juntos; esto se indica a veces por sangría todos menos la primera con un espacio adicional (después de la coma).

2.4.4.2.2 Uso del punto y coma doble

Los comentarios que comienzan con un punto y coma doble están alineados al mismo nivel de sangría que una forma estaría en la misma posición en el código. El texto de tal comentario generalmente describe el estado del programa en el punto donde se produce el comentario, el código que sigue al comentario, o ambos.

2.4.4.2.3 Uso del punto y coma triple

Los comentarios que comienzan con un punto y coma triple son todos alineados al margen izquierdo. Por lo general, se utilizan antes de una definición o conjunto de definiciones, en lugar de dentro de una definición.

2.4.4.2.4 Uso del punto y coma Cuádruple

Los comentarios que comienzan con un punto y coma cuádruple están todos alineados al margen izquierdo, y generalmente contienen solo un fragmento de texto corto que sirve como título para el código que sigue, y podría usarse en el encabezado o pie de página de un programa que prepara el código para su presentación como una copia impresa documento.

2.4.4.2.5 Ejemplos de estilo para Punto y coma

;;;; Math Utilities

;;; FIB computes the the Fibonacci function in the traditional
;;; recursive way.

(defun fib (n)
  (check-type n integer)
  ;; At this point we're sure we have an integer argument.
  ;; Now we can get down to some serious computation.
  (cond ((< n 0)
         ;; Hey, this is just supposed to be a simple example.
         ;; Did you really expect me to handle the general case?
         (error "FIB got ~D as an argument." n))
        ((< n 2) n)             ;fib[0]=0 and fib[1]=1
        ;; The cheap cases didn't work.
        ;; Nothing more to do but recurse.
        (t (+ (fib (- n 1))     ;The traditional formula
              (fib (- n 2)))))) ; is fib[n-1]+fib[n-2].