リーダブルコード ―より良いコードを書くためのシンプルで実践的なテクニック

6章コメントは正確で簡潔に

前章では、何をコメントに書くべきかを説明した。本章では、どうすればコメントを正確で簡潔に書けるかを説明する。

コメントを書くのであれば、正確に書くべきだ（できるだけ明確で詳細に）。また、コメントには画面の領域を取られるし、読むのにも時間がかかるので、簡潔なものでなければいけない。

	鍵となる考え コメントは領域に対する情報の比率が高くなければいけない。

これからそのやり方を見ていこう。

6.1　コメントを簡潔にしておく

以下は、C++の型定義につけたコメントの例だ。

// intはCategoryType。
// pairの最初のfloatは'score'。
// 2つめは'weight'。
typedef hash_map<int, pair<float, float> > ScoreMap;

どうして3行も使って説明しているのだろう？　これなら1行で説明できないだろうか？

// CategoryType -> (score, weight)
typedef hash_map<int, pair<float, float> > ScoreMap;

3行分の領域が必要なこともあるだろう。でも、ここには必要ない。

6.2　あいまいな代名詞を避ける ...