Додаток D.7 до посібника Emacs Lisp містить додаткові поради щодо коментарів:
;
Для вбудованих коментарів слід використовувати одиничні крапки з комою ( ).;;
Для коментарів до рядків слід використовувати подвійні крапки з комою ( ).- Потрійні крапки з комою (
;;;
) повинні використовуватися для "коментарів, які слід вважати заголовком в режимі другорядного режиму". - Чотириразові крапки з комою (
;;;;
) повинні використовуватися для заголовків основних розділів програми.
Випадки використання одинарної та подвійної крапки з комою є чіткими, але, схоже, немає різкого розмежування між потрійними та чотирикратними крапками з комою.
Зокрема, стандартна документація на пакети Emacs, що надається із auto-insert
застосуванням потрійних крапних крапок, ніколи не чотиризначних крапкових колон, навіть для заголовків найвищого рівня, таких як назва файлу та основні розділи. Дивіться приклад нижче:
;;; 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
Які найкращі практики для потрійних та чотирьох крапних крапок?
Оновлення
Завдяки відповіді Стефана я подав повідомлення про помилку і зробив наступну пропозицію:
Я пропоную змінити опис на три крапки з комою на:
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 було б корисно: https://www.gnu.org/software/emacs/manual/html_node/emacs/Outline-Mode.html
Розділ на чотири крапки з комою можна пропустити.
grep -r '^;;;; ' lisp
) для натхнення.