リーダブルコード

プログラマーの必読書とも言われる書籍。特に気になった部分を備忘録として掲載。

// TODO: もっと高速なアルゴリズムを使う
// TODO: JPEG以外のフォーマットに対応する

よく使われる記法

TODO: あとで手を付ける
FIXME: 既知の不具合があるコード
HACK: あまりキレイじゃない解決策
XXX: 危険！大きな問題がある

大切なのは、これからこのコードをどうしたいのかをコメントに書くこと。 それにより、コードの品質や状態を知らせたり、改善の方向を示したりできる。

定数を定義するときには「背景」が存在する場合が多い。 なかには名前が明確なのでコメントが必要ない定数もあるが、コメントをつけることで明確になる定数は多い。 定数の値を決めたときに頭の中で考えていたことを記録することが大切。 （あとからこのコードを触る人の、定数の意味を調査・推測する時間を節約できる）

// 合理的な限界値。人間はこんなに読めない。
const MAX_RSS_SUBSCRIPTIONS = 1000;

// 0.72ならユーザはファイルサイズと品質の面で妥協できる。
const IMAGE_QUALITY = 0.72;