コメント (プログラミング言語、マーク付け言語)

[21] コメント (comment) は、何らかの注釈を挿入するものです。

呼称

[22] 現代日本ではコメント、comment という呼称が広く通用しています。

[23] SGML 関係などでは注釈とも訳されています。

[24] ただし注釈は annotation の訳語にも使われていて紛らわしいので要注意です。

いろいろなコメント

[1] コメント

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

[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