コメントの中身に意味を持たせる

[2] コメントの中身は本来完全に無視されるべきもののはずですが、意味を持たせて使われることがあり、まったく完全に無視されるとも言えない場面があります。

[3] コメントの中身が意味を持ってしまうというのにもいくつかの類型があります。

[5] A 仕様では意味がないが、 A が発展した A' では意味がある
[7] A 仕様では意味がないが、 A 言語を出力する前処理言語 (雛形言語など) では意味がある
[8] A 仕様では意味がないが、 A 言語を一部解釈して利用するシステムが利用する
[9] A 仕様において通常のコメントと特殊なコメントの機能を分けて提供している

[10] HTMLにおける事例はHTMLにおける他言語統合点を参照。

[15] conventional comment

[11] Java では通常のコメントの他に documentation comment があって、少し違う構文でドキュメント生成用の定型のコメントを書けます。 JavaDoc

[12] ちょっと似てるけど違う事例として、 Perl には通常のコメントと、それとまったく異なるドキュメント用の pod 構文があります。 pod はドキュメントとしての本来の用法の他でも、事実上の複数行コメントとして便利に使われています。勝手に乱用されているのではなく、公式にも容認された使い方です。

[14] shebang, ファイル変数, -*-, vim:, kate:, SPDX-License-Identifier:, ‘magic’ comment, %#記法, %SourceDoc, swift-tools-version, //bo:build, // +build, //go:binary-only-package, #%RAML

[28] //# sourceMappingURL=

[31] #region, #endregion

[30] # spellcheck, # noqa, # flake8, # nopep8, #: PEP8, # type: ignore, 型注釈, jshint, jslint, globals, exported, eslint, //noinspection, ##no critic

[16] Received: の comment, comment 内の encoded-word

[19] mailbox

[18] User-Agent:

[20] ZIPファイルの署名

[25] POファイル

[26] ちょっと違うタイプ: CSSの注釈

[32] 文字コードの判定のヒントとして、判定の役に立つとされる文字列を注釈に書き入れる技法があります。文字コードの判定

[17] 関連: 拡張可能性, 私用, 非標準空間が標準化される, テキストファイルの先頭

[29] PEP 723 – Inline script metadata | peps.python.org, 2025-06-29T22:56:36.000Z, 2025-06-30T07:02:08.440Z https://peps.python.org/pep-0723/

呼称

いろいろなコメント

コメントの中身に意味を持たせる

DSSSL の注釈

メモ