Top > Programming > CommonTips > Comment in Source code
Last-modified: Mon, 05 May 2014 01:48:00 JST
Counter:1348 Today:2 Yesterday:0 Online:16
このエントリーをはてなブックマークに追加

ソースコード中のコメントについて

コーディングしていて、何度か思い当たることがあったので、次回以降に思いついたときにまとめておきます。

短いコードを読んで分かることはコメントには書かない。

多くの場合、2-3行程度の短いソースコードにはコメントを書く必要はないでしょう。そのソースコードを読んで処理内容が理解できるように改めるべきです。ただし、それが複数の関数の連続から成る、横に長いコードであればコメントが必要になるかもしれませんが。

変数名を説明するためのコメントは書かない

変数名を説明するためのコメントは書かない。変数名によって、どのような変数であるかを示すようにする。

//ユーザ数を保存しておく
int c = 0;
int usercount = 0;

※ショートコーディングが必要であるなら、あとで機械的に行った方が良い。人為的にショートコーディングするのは趣味の領域を出ない。

複数行コメントは統一する

複数行のコメントアウトをする方法は統一しておく。単一行のコメントを複数回繰り返すのか、あるいは、複数行一度にコメントアウトするのか、のいずれか。開発環境によって異なるが、その開発環境のショートカットコマンドで実行されるコメントアウトの方に合わせる。

//first line.
//second line.

あるいは以下のようになる。これの限りではないが、統一されることが重要である。

/*
* first line.
* second line.
*/

ただし、コーディング中に、部分的にコードをコメントアウトしてデバッグする際には、前者のように、単一行のコメントを複数回繰り返すパターンの方が使いやすいでしょう。私の場合はこのために前者のパターンを利用しています。複数行のコメントアウトは、末尾を示すコードが現れるように修正する必要があるためです。