文書の過去の版を表示しています。
// TODO: もっと高速なアルゴリズムを使う // TODO: JPEG以外のフォーマットに対応する
よく使われる記法
TODO: あとで手を付ける FIXME: 既知の不具合があるコード HACK: あまりキレイじゃない解決策 XXX: 危険!大きな問題がある
大切なのは、これからこのコードをどうしたいのかを自由にコメントに書くことだ。 それにより、コードの品質や状態を知らせたり、改善の方向を示したりできるのだ。
定数を定義するときには「背景」が存在する場合が多い。 なかには名前が明確なのでコメントが必要ない定数もあるが、コメントをつけて改善できる定数は多い。 定数の値を決めたときに頭の中で考えていたことを記録することが大切なのだ。
// 合理的な限界値。人間はこんなに読めない。 const MAX_RSS_SUBSCRIPTIONS = 1000; // 0.72ならユーザはファイルサイズと品質の面で妥協できる。 const IMAGE_QUALITY = 0.72;
コメント