Dodatek D.7 do podręcznika Emacs Lisp Reference Manual wymienia kilka wskazówek dotyczących komentarzy:
;
Do wstawiania komentarzy należy stosować pojedyncze średniki ( ).- W
;;
komentarzach do wiersza należy stosować podwójne średniki ( ). - Potrójnych średników (
;;;
) należy używać w przypadku „komentarzy, które należy traktować jako nagłówek według trybu pomocniczego Zarys”. - Czterokrotnych średników (
;;;;
) należy używać w nagłówkach głównych sekcji programu.
Przypadki użycia pojedynczego i podwójnego średnika są jasne, ale wydaje się, że nie ma wyraźnego rozgraniczenia między potrójnymi i poczwórnymi średnikami.
W szczególności standardowa dokumentacja pakietów Emacsa udostępniana przez auto-insert
używa potrójnych średników, nigdy nie czterokrotnie średników, nawet dla nagłówków najwyższego poziomu, takich jak nazwa pliku i główne sekcje. Zobacz przykład poniżej:
;;; 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
Jakie są najlepsze praktyki dla potrójnych i poczwórnych średników?
Aktualizacja
Dzięki odpowiedzi Stefana złożyłem raport o błędzie i przedstawiłem następującą sugestię:
Sugeruję zmianę opisu trzech średników na:
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.
Przydałby się link do „Zarys trybu mniejszego” w podręczniku Emacsa: https://www.gnu.org/software/emacs/manual/html_node/emacs/Outline-Mode.html
Sekcja czterech średników może zostać pominięta.
grep -r '^;;;; ' lisp
) w poszukiwaniu inspiracji.Odpowiedzi:
W rzeczywistości 3-i więcej średników oznacza nagłówki, w których im więcej średników, tym głębsze zagnieżdżenie nagłówka. Tak powinno wyglądać
źródło
emacs-lisp-mode
konfigurujeoutline-minor-mode
. Sugeruję, aby zgłosić to jako błąd w dokumentacji (myślę, że dokument jest niejasny niż zły, ale wynik końcowy jest taki sam).git://git.sv.gnu.org/emacs.git
a następnie wysłać łatkę za pośrednictwemM-x report-emacs-bug
.