コメント (コンピュータ)
出典: フリー百科事典『ウィキペディア(Wikipedia)』 (2023/03/28 22:40 UTC 版)
備考
オープンソース/クローズドソースを問わず、コメントはプログラムの共同開発やソースコードの保守管理に欠かせないものである。特にプログラム内にコメントによるドキュメントを含ませることで、チームを組んで共同作業したり保守したりするうえで役立つ。また、担当者が変わった後でも保守・改良、またはバグ修正に大きな力を発揮する。ただし、それは「正しいコメントが記述されている」という前提の話である。間違ったコメントが書かれている場合、解読を妨げたり誤解を生んだりする原因にもなる。
コメントの良し悪しは、読者の前提知識や主観もかかわってくるので、どのようなコメントが適切であるかは一概には述べることができない。プログラムコードの各ステップ行で何を実行しているかを自然言語によって逐一説明するようなコメントは、「冗長である」「記憶領域を無駄に浪費する」「読みづらくなる」などの短所をはらむ可能性もあるが、初心者や入門者向けのサンプルコードとしては役に立つこともある。
プログラムコードの本文を読めば、「何を実行しているか」自体は分かるため、コメントには「何を実行しているか」を記述するよりも、「なぜそのようなコードを書いたのか」という設計理由を記述するべきである、という方法論もある[5]。
脚注
関連項目
注釈
- ^ 言語構文によっては一定の制約があり、例えばC言語における
/*
-*/
のように、開始トークンと終了トークンを持つコメント構文の場合は、コメントの本文中には終了トークンを記述できない。また、一般的には同一の開始トークンと終了トークンを入れ子にすることもできない(後述するD言語における/+
-+/
のような例外もある)。 - ^ テキストエディタや統合開発環境の中には、選択中の複数行に対してコマンドを実行すると、各行に対し行コメントのトークンを追加し、まとめてコメント化できるものもある。
- ^ 行コメントが標準化されたのはC99規格以降だが、C99よりも前に拡張機能としてサポートしていた処理系もあった。
- ^ ASCIIのシングルクォーテーションはアポストロフィの代用として使われることもあるため、便宜上アポストロフィと呼ばれたり、混同されたりすることもあるが、文字コードとしては別物である。
- ^ ASCIIのナンバーサインはシャープの代用として使われることもあるため、便宜上シャープと呼ばれたり、混同されたりすることもあるが、文字コードとしては別物である。
出典
- コメント (コンピュータ)のページへのリンク