L' Appendice D.7 del Manuale di riferimento di Emacs Lisp menziona alcuni suggerimenti per i commenti:
- I punti e virgola singoli (
;
) devono essere utilizzati per i commenti incorporati. - I punti e virgola doppi (
;;
) devono essere utilizzati per i commenti di riga. - Il punto e virgola triplo (
;;;
) dovrebbe essere usato per "commenti che dovrebbero essere considerati un'intestazione dalla modalità Contorno minore". - I punti e virgola quadrupli (
;;;;
) dovrebbero essere usati per le intestazioni delle sezioni principali di un programma.
I casi d'uso del punto e virgola doppio e doppio sono chiari, ma non sembra esserci una netta delimitazione tra punti e virgola tripli e quadrupli.
In particolare, la documentazione standard per i pacchetti Emacs fornita da auto-insert
utilizza punti e virgola tripli, mai quadrupli, anche per le intestazioni di livello più alto come il nome del file e le sezioni principali. Vedi l'esempio seguente:
;;; test.el --- A test file. -*- lexical-binding: t; -*-
;; Copyright (C) 2016
;; Author: John Smith
;; Keywords:
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;;
;;; Code:
(provide 'test)
;;; test.el ends here
Quali sono le migliori pratiche per i punti e virgola tripli e quadrupli?
Aggiornare
Grazie alla risposta di Stefan , ho presentato una segnalazione di bug e ho dato il seguente suggerimento:
Suggerisco di modificare la descrizione per tre punti e virgola in:
Comments that start with three semicolons, ‘;;;’, are considered top-level headings by Outline minor mode. Four or more semicolons can be used as subheadings in hierarchical fashion. E.g. ;;; Main heading ;;;; Sub heading ;;;;; Sub sub heading ;;;; Another sub heading ;;; Next main heading These comments should be used to break Emacs Lisp code into sections.
Un link a "Delinea la modalità minore" nel manuale di Emacs sarebbe utile: https://www.gnu.org/software/emacs/manual/html_node/emacs/Outline-Mode.html
È possibile eliminare la sezione per quattro punti e virgola.
grep -r '^;;;; ' lisp
) per trovare ispirazione.