[21]
[DFN[[RUBYB[コメント][comment]]]]は、
何らかの[[注釈]]を挿入するものです。
* 呼称
[22]
[[現代日本]]では[[コメント]]、[[comment]] という呼称が広く通用しています。
[23]
[[SGML]] 関係などでは[DFN[注釈]]とも訳されています。
[24]
ただし[[注釈]]は [[annotation]] の訳語にも使われていて紛らわしいので要注意です。
* いろいろなコメント
[FIG(short list)[ [1] [[コメント]]
- [[UCD]]
]FIG]
*コメントの中身に意味を持たせる
[2]
[[コメント]]の中身は本来完全に無視されるべきもののはずですが、
意味を持たせて使われることがあり、
まったく完全に無視されるとも言えない場面があります。
[3]
[DFN[コメントの中身が意味を持ってしまう]]というのにもいくつかの類型があります。
- [5] [VAR[A]] 仕様では意味がないが、 [VAR[A]] が発展した [VAR[A']] では意味がある
- [7] [VAR[A]] 仕様では意味がないが、 [VAR[A]] 言語を出力する[[前処理]]言語 ([[雛形言語]]など) では意味がある
- [8] [VAR[A]] 仕様では意味がないが、 [VAR[A]] 言語を一部解釈して利用するシステムが利用する
- [9] [VAR[A]] 仕様において通常の[[コメント]]と特殊な[[コメント]]の機能を分けて提供している
[10] [[HTML]]における事例は[[HTMLにおける他言語統合点]]を参照。
[15] [[conventional comment]]
[11] [[Java]] では通常の[[コメント]]の他に [[documentation comment]] があって、
少し違う構文で[[ドキュメント]]生成用の定型の[[コメント]]を書けます。
[SEE[ [[JavaDoc]] ]]
;; [12]
ちょっと似てるけど違う事例として、 [[Perl]]
には通常の[[コメント]]と、それとまったく異なる[[ドキュメント]]用の [[pod]]
構文があります。 [[pod]] は[[ドキュメント]]としての本来の用法の他でも、
事実上の複数行コメントとして便利に使われています。
勝手に乱用されているのではなく、公式にも容認された使い方です。
[14] [[shebang]],
[[ファイル変数]],
[CODE[-*-]],
[CODE[vim:]],
[CODE[kate:]],
[CODE[SPDX-License-Identifier:]],
[[‘magic’ comment]],
[[[CODE[%#]]記法]],
[CODE[%SourceDoc]],
[CODE[swift-tools-version]],
[CODE[//bo:build]],
[CODE[// +build]],
[CODE[//go:binary-only-package]],
[CODE[#%RAML]]
[28]
[CODE[//# sourceMappingURL=]]
[31]
[CODE[#region]], [CODE[#endregion]]
[30]
[CODE[# spellcheck]],
[CODE[# noqa]],
[CODE[# flake8]],
[CODE[# nopep8]],
[CODE[#: PEP8]],
[CODE[# type: ignore]],
[[型注釈]],
[CODE[jshint]],
[CODE[jslint]],
[CODE[globals]],
[CODE[exported]],
[CODE[eslint]],
[CODE[//noinspection]],
[CODE[##no critic]]
[16] [CODE[Received:]] の [CODE[comment]],
[CODE[comment]] 内の [CODE[encoded-word]]
[19] [CODE[mailbox]]
[18] [CODE[User-Agent:]]
[20] [[ZIPファイルの署名]]
[25] [[POファイル]]
[26] ちょっと違うタイプ:
[[CSSの注釈]]
[32]
[[文字コードの判定]]のヒントとして、判定の役に立つとされる文字列を[[注釈]]に書き入れる技法があります。
[SEE[ [[文字コードの判定]] ]]
[17] 関連: [[拡張可能性]],
[[私用]],
[[非標準空間が標準化される]],
[[テキストファイルの先頭]]
[29]
[CITE@en[PEP 723 – Inline script metadata | peps.python.org]], [TIME[2025-06-29T22:56:36.000Z]], [TIME[2025-06-30T07:02:08.440Z]]
* DSSSL の注釈
- [4] [CODE(ABNF)[[DFN[注釈]] := ";" *([[文字]] − [[記録終了]]) ;; [[JISX4153]]:1998 [13] ]]
* メモ
[6] comments-in-computer-languages
: ありとあらゆる言語における注釈の表現
[46]
[CITE[Acme::Comment - search.cpan.org]] ([CODE[2007-10-06 10:49:14 +09:00]] 版)
([[名無しさん]])
[47]
>>6
[27] [CITE[トリセカ第102回 出演:大空直美 大和田仁美 - 2024/10/11(金) 20:55開始 - ニコニコ生放送]]
([TIME[2024-10-15 13:27:59 +09:00]])