Emacs Lispリファレンスマニュアルの付録D.7には、コメントのヒントがいくつか記載されています。
;
インラインコメントには単一のセミコロン()を使用する必要があります。;;
行コメントには二重セミコロン()を使用する必要があります。- トリプルセミコロン(
;;;
)は、「アウトラインマイナーモードによる見出しと見なされるコメント」に使用する必要があります。 ;;;;
プログラムの主要セクションの見出しには、4つのセミコロン()を使用する必要があります。
シングルセミコロンとダブルセミコロンのユースケースは明確ですが、トリプルセミコロンとクアッドセミコロンの間に明確な線引きはないようです。
特に、提供されるEmacsパッケージの標準ドキュメントでauto-insert
は、ファイル名や主要セクションなどの最高レベルの見出しであっても、トリプルセミコロンを使用し、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
トリプルおよび四重セミコロンのベストプラクティスは何ですか?
更新
Stefanの回答のおかげで、バグ報告を提出し、次の提案を行いました。
3つのセミコロンの説明を次のように変更することをお勧めします。
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
4つのセミコロンのセクションは省略できます。
;;;;のいくつかの非標準アプリケーションを表示する@sds 標準的なソースで;)
—
タイラー
それが私が意図したことです-この4セミコロンの推奨事項はあまり真剣に受け止めることはできません。
—
sds
grep -r '^;;;; ' lisp
インスピレーションについては、Emacsのソース()をご覧ください。