『もっとコメント論 ～その３～ 注釈としてのコメント』

悪態のプログラマとある職業プログラマの悪態を綴る。 入門書が書かないプログラミングのための知識、会社の研修が教えないシステム開発業界の裏話は、新人プログラマや、これからプログラマを目指す人たちへのメッセージでもある。 私が書いて欲しいと思うコメントとして、前回 は「見出しとしてのコメント」について述べた。今回は、もうひとつ、「注釈としてのコメント」について書いておこうと思う。 注釈とは そもそも「注釈」は「comment」の訳語のひとつであり、「ソースコードのコメント」としても、最も一般的な用途でもあるだろう。 「Yahoo!辞書 - 大辞泉 」によると、注釈とは「語句の意味や用法を解説したり、補足的な説明を加えたりすること。また、その説明。」である。ソースコードに書く場合にも、本質的な違いはないだろう。 注釈を書く目的は、読者の理解を助け、誤解のないようにすることである。まず、プログラマ

[kilynn]

コメントには「HOW」ではなく「WHY」を書け