読者です 読者をやめる 読者になる 読者になる

日々常々

ふつうのプログラマがあたりまえにしたいこと。

コメントを「紹介文」と考えてみる

「コメント」って言う名前が微妙なんじゃないかなと思った次第。

と言うのも、(コード的な意味でない、例えばブログとかの)コメントって、何か本文とかに付け足すものな感じがする。commentの意味には「説明する」とかもあるっぽいんだけど、それでもなんか「他人が書いたものに対してするもの」な感じがする。

実際に(コード的な意味での)コメントを書く状況を考える。と言うかコメントについては考え済みなので、これを下敷きにする。

さらにコメントを書く場所を考える。行末や後置することも無いとは言わないけど、前に置くのが基本。この時点で「付け足すもの」的なコメントとは異なる性質がある。つまり「先に読まれる」んだ。ならば(コード的な意味でない)コメントと同じ名前で考えると混乱するのではないかなと。

コード的な意味でない コード的な意味での
後ろに書く 前に書く
後で書く 先に書くこともある
本文の後に読まれる 本文の前に読まれる
他の人が書く 自分で書く

なんか(コード的な意味でない)コメントの後付け感。コメントってそう言うものか……となると、わざわざコードに対して直接、しかも本文よりも前に書かれ、ややもすれば本文よりもよく読まれる(コード的な意味での)コメントに「コメント」が相応しくないんじゃないかなと。少なくとも捉え方として。


ちょっと考えて出てきたのが「紹介文」って言うの。*1
本文では語られない、先に知っていると内容を理解する上で助けになるもの。漫画や小説のキャラ紹介などがその辺にあたる。これは本文を読む上では支障にならないことも多いけど、あれば役に立つことも多い。書かれるのは内容じゃなく性質な感じですかね。
本文を読むかどうか、それを判断するための情報。本の推薦文とかがそれですね。後書きではなく。まだ読んでいない人に対して、読むかどうか、その本を買うかどうか、それを適切に判断できるもの。ここには内容を含む場合もあるけれど、極端に要約されたものになると思う。
この辺りの考え方にコード的でない意味をもたれがちなコメントって言葉を使うもんだから、なんか無理矢理後に付け足して説明してるようなウンコメントを書いちゃったりするんじゃないかなと。


と言うことで。もしかしたら「紹介文」と考えたら、いい感じのコメントが書けるんじゃないかなー。

*1:いや正直考えてないんだけど、先にふとそう思って無理矢理理由付けしてるのがこのエントリなんだけど。