Emacs Lispのコメント規約


17

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つのセミコロンのセクションは省略できます。


grep -r '^;;;; ' lispインスピレーションについては、Emacsのソース()をご覧ください。
sds

;;;;のいくつかの非標準アプリケーションを表示する@sds 標準的なソースで;)
タイラー

それが私が意図したことです-この4セミコロンの推奨事項はあまり真剣に受け止めることはできません。
sds

回答:


13

実際、3つ以上のセミコロンは見出しを表し、セミコロンが多くなるほど見出しのネストが深くなります。ので、それは次のようになります

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

これは一般的な慣行のようですが、質問にリンクされているElispマニュアルにリストされている規則とは異なります。それはマニュアルのバグですか?
タイラー

3
それは単なる練習の問題ではありません。それがemacs-lisp-modeconfigure の方法outline-minor-modeです。これをドキュメンテーションのバグとして報告することをお勧めします(ドキュメンテーションは間違っているよりも不明瞭だと思いますが、最終結果は同じです)。
ステファン

バグレポートを送信し、ドキュメントを別のドキュメントに変更するよう提案しました。マニュアルのTexInfoソースを取得できることがわかりました。クローンを作成してプルリクエストを行うことができるリポジトリはありますか?
天翔Xiong

@TianxiangXiong:もちろん、ドキュメントはEmacsのソースコードの一部であるため、クローンを作成してgit://git.sv.gnu.org/emacs.gitからパッチを送信できますM-x report-emacs-bug
ステファン

参考のために、ここにCommon Lispの規則を示します。Emacs Lispが実際に見出しに3セミコロンを使用し、次に目立たない見出しに4セミコロンを使用する場合、それは非論理的であり、CLやその他のlispsで見たものとは逆に見えます。多分それは単に組織モードの見出しに適しているので、彼らはelispにもそれを使いました。
ラッシー
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.