이맥스 리스프 주석 규칙

Emacs Lisp Reference Manual의 부록 D.7에 몇 가지 주석 팁이 있습니다.

• ;인라인 주석에는 단일 세미콜론 ( )을 사용해야합니다.
• ;;줄 주석에는 이중 세미콜론 ( )을 사용해야합니다.
• 트리플 세미콜론 ( ;;;)은 "개요 마이너 모드로 제목으로 간주되어야하는 주석"에 사용해야합니다.
• ;;;;프로그램의 주요 섹션으로 향하는 데 4 중 세미콜론 ( )을 사용해야합니다.

단일 및 이중 세미콜론 사용 사례는 명확하지만 3 중 및 4 중 세미콜론 사이에는 뚜렷한 묘사가없는 것 같습니다.

특히, 제공되는 Emacs 패키지의 표준 문서는 auto-insert파일 이름 및 주요 섹션과 같은 최상위 레벨의 경우에도 3 중 세미콜론 을 사용하며 4 중 세미콜론은 사용하지 않습니다. 아래 예를 참조하십시오.

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

3 중 및 4 중 세미콜론에 대한 모범 사례는 무엇입니까?

최신 정보

Stefan의 답변 덕분에 버그 보고서를 제출하고 다음과 같이 제안했습니다.

세 개의 세미콜론에 대한 설명을 다음과 같이 변경하는 것이 좋습니다.

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 매뉴얼의 "Outline minor mode"링크가 유용합니다 : https://www.gnu.org/software/emacs/manual/html_node/emacs/Outline-Mode.html

4 개의 세미콜론 섹션을 생략 할 수 있습니다.

실제로 3 개 이상의 세미콜론은 제목을 의미하며, 세미콜론이 많을수록 제목의 중첩이 깊어집니다. 이렇게 보일 것입니다

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