Emacs Lisp yorum kuralları

Emacs Lisp Başvuru Kılavuzu'nun Ek D.7'sinde bazı yorum ipuçlarından bahsedilmektedir:

• ;Satır içi yorumlar için tek noktalı virgül ( ) kullanılmalıdır.
• ;;Satır yorumları için çift ​​noktalı virgül ( ) kullanılmalıdır.
• Üçlü noktalı virgül ( ;;;) "Anahat küçük modu tarafından başlık olarak görülmesi gereken yorumlar" için kullanılmalıdır.
• ;;;;Bir programın ana bölümlerinin başlıkları için dörtlü noktalı virgül ( ) kullanılmalıdır.

Tek ve çift noktalı virgül kullanım durumları açıktır, ancak üçlü ve dörtlü noktalı virgüller arasında keskin bir tanımlama yoktur.

Özellikle, Emacs paketleri için sağlanan standart dokümantasyon auto-insert, dosya adı ve ana bölümler gibi en üst düzey başlıklar için bile, hiçbir zaman dört noktalı virgül kullanmaz, hiçbir zaman dört noktalı virgül kullanmaz. Aşağıdaki örneğe bakın:

;;; 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

Üçlü ve dörtlü noktalı virgül için en iyi uygulamalar nelerdir?

Güncelleme

Stefan'ın cevabı sayesinde bir hata raporu hazırladım ve aşağıdaki öneride bulundum:

Üç noktalı virgül için açıklamanın şu şekilde değiştirilmesini öneririm:

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.

Emacs kılavuzundaki "Küçük modu özetle" bağlantısı faydalı olacaktır: https://www.gnu.org/software/emacs/manual/html_node/emacs/Outline-Mode.html

Dört noktalı virgül için bölüm seçilebilir.

Aslında, 3 ve daha fazla noktalı virgül, başlıkların kısaltmasıdır; daha fazla noktalı virgül, başlığın iç içe yerleşmesini daha derine koyarsınız. Yani böyle görünmeli

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