Konwencje komentowania Emacsa Lispa

17

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-insertuż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.

Tianxiang Xiong
źródło
Przejrzyj źródła Emacsa ( grep -r '^;;;; ' lisp) w poszukiwaniu inspiracji.
sds
@sds, które pokazuje kilka niestandardowych aplikacji ;;;; w źródłach kanonicznych;)
Tyler,
Właśnie to miałem na myśli - tej rekomendacji z 4 średnikami nie można brać zbyt poważnie, OTOH, należy również spojrzeć na znacznik czasu pliku - te niestandardowe rzeczy mogą być przestarzałe.
sds

Odpowiedzi:

13

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ć

;;; Main heading
;;;; Sub heading
;;;;; Sub sub heading
;;;; Another sub heading
;;; Next main heading
Stefan
źródło
Wydaje się, że jest to powszechna praktyka, ale różni się od konwencji wymienionych w podręczniku Elisp powiązanym z pytaniem. Czy to błąd w instrukcji?
Tyler
3
To nie tylko kwestia praktyki. Tak się emacs-lisp-modekonfiguruje outline-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).
Stefan
Wysłałem raport o błędzie i zaproponowałem zmianę dokumentacji na coś innego. Widzę, że mogę pobrać źródło TexInfo do instrukcji; czy istnieje repozytorium, które mogę sklonować i wysłać żądanie ściągnięcia?
Tianxiang Xiong
@TianxiangXiong: Oczywiście, dokument jest częścią kodu źródłowego Emacsa, więc możesz sklonować, git://git.sv.gnu.org/emacs.gita następnie wysłać łatkę za pośrednictwem M-x report-emacs-bug.
Stefan
Dla porównania, oto konwencje Common Lisp . Jeśli Emacs Lisp naprawdę używa 3 średników dla nagłówka, a następnie 4 średników dla mniej widocznego nagłówka, wydaje się to nielogiczne i sprzeczne z tym, co widziałem w CL i innych seplenieniach. Może po prostu lepiej pasuje do nagłówków w stylu org, więc poszli z tym także w przypadku elisp.
Lassi