Конвенції про коментарі Emacs Lisp


17

Додаток 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

Розділ на чотири крапки з комою можна пропустити.


Перегляньте джерела Emacs ( grep -r '^;;;; ' lisp) для натхнення.
sds

@sds, що відображає кілька нестандартних додатків програми ;;;; у канонічних джерелах;)
Тайлер

Ось що я мав на увазі - цю 4-кратну крапку з рекомендаціями не можна сприймати занадто серйозно, OTOH, слід також переглянути часову позначку файлу - ці нестандартні речі можуть бути застарілими.
sds

Відповіді:


13

Насправді 3-і більше напівколонок стоять за заголовками, де чим більше напівколонок ви покладете, тим глибше вкладаються заголовки. Так має виглядати

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

Це, здається, є звичайною практикою, але відрізняється від конвенцій, перелічених у посібнику Елісп, пов'язаному з питанням. Це помилка в керівництві?
Тайлер

3
Це не лише питання практики. Ось як emacs-lisp-modeналаштовується outline-minor-mode. Я пропоную вам повідомити про це як про помилку в документації (я думаю, що документ незрозуміло більш ніж неправильно, але кінцевий результат той самий).
Стефан

Я надіслав звіт про помилку і запропонував змінити документацію на щось інше. Я бачу, що я можу отримати джерело TexInfo для посібника; чи є сховище, до якого я можу клонуватись та робити запит на тягнення?
Tianxiang Xiong

@TianxiangXiong: Звичайно, doc є частиною вихідного коду Emacs, тому ви можете клонувати git://git.sv.gnu.org/emacs.gitі потім надсилати патч через M-x report-emacs-bug.
Стефан

Для довідки, тут наведені загальні конвенції Ліса . Якщо Emacs Lisp дійсно використовує 3 крапки з комою для заголовка, але потім 4 крапки з комою для менш помітного заголовка, це здається нелогічним і суперечить тому, що я бачив у CL та інших листах. Можливо, це просто краще підходить для заголовків у стилі org-mode, тому вони йшли з ним і для Elisp.
Лассі
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.