Convenzioni sui commenti di Emacs Lisp


17

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-insertutilizza 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.


Cerca le fonti di Emacs ( grep -r '^;;;; ' lisp) per trovare ispirazione.
sds

@sds che presenta alcune applicazioni non standard di ;;;; nelle fonti canoniche;)
Tyler

Questo è ciò che intendevo dire: questa raccomandazione di 4 punti e virgola non può essere presa troppo sul serio, OTOH, si dovrebbe anche guardare il timestamp del file: queste cose non standard potrebbero essere obsolete.
sds

Risposte:


13

In realtà, 3 e più punti e virgola indicano intestazioni, dove più punti e virgola si inserisce più in profondità la nidificazione dell'intestazione. Quindi dovrebbe sembrare

;;; Main heading
;;;; Sub heading
;;;;; Sub sub heading
;;;; Another sub heading
;;; Next main heading

Questa sembra essere la pratica comune, ma differisce dalle convenzioni elencate nel manuale Elisp collegato alla domanda. È un bug nel manuale?
Tyler,

3
Non è solo una questione di pratica. Ecco come si emacs-lisp-modeconfigura outline-minor-mode. Ti suggerisco di segnalarlo come un bug di documentazione (penso che il documento non sia più chiaro che sbagliato, ma il risultato finale è lo stesso).
Stefan

Ho inviato una segnalazione di bug e ho offerto un suggerimento per cambiare la documentazione in qualcos'altro. Vedo che posso ottenere la fonte TexInfo per il manuale; esiste un repository su cui posso clonare ed effettuare una richiesta pull?
Tianxiang Xiong

@TianxiangXiong: Certo, il documento fa parte del codice sorgente di Emacs, quindi puoi clonare git://git.sv.gnu.org/emacs.gite quindi inviare una patch tramite M-x report-emacs-bug.
Stefan,

Per riferimento, ecco le convenzioni del Lisp comune . Se Emacs Lisp usa davvero 3 punti e virgola per un'intestazione ma poi 4 punti e virgola per un'intestazione meno prominente, ciò sembra illogico e contrario a quello che ho visto in CL e altre lisps. Forse è semplicemente una soluzione migliore per le intestazioni in stile org, quindi sono andate bene anche per elisp.
Lassi,
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.