このページの2つのバージョン間の差分を表示します。
両方とも前のリビジョン 前のリビジョン | |||
書籍:リーダブルコード [2019/02/05 12:43] yusuke_komori |
書籍:リーダブルコード [2020/06/03 10:25] (現在) humolife |
||
---|---|---|---|
行 17: | 行 17: | ||
XXX: 危険!大きな問題がある | XXX: 危険!大きな問題がある | ||
</ | </ | ||
- | 大切なのは、これからこのコードをどうしたいのかを自由にコメントに書くことだ。 | + | 大切なのは、これからこのコードをどうしたいのかをコメントに書くこと。 |
- | それにより、コードの品質や状態を知らせたり、改善の方向を示したりできるのだ。 | + | それにより、コードの品質や状態を知らせたり、改善の方向を示したりできる。 |
=== 定数にコメントをつける === | === 定数にコメントをつける === | ||
定数を定義するときには「背景」が存在する場合が多い。 | 定数を定義するときには「背景」が存在する場合が多い。 | ||
- | なかには名前が明確なのでコメントが必要ない定数もあるが、コメントをつけて改善できる定数は多い。 | + | なかには名前が明確なのでコメントが必要ない定数もあるが、コメントをつけることで明確になる定数は多い。 |
- | 定数の値を決めたときに頭の中で考えていたことを記録することが大切なのだ。 | + | 定数の値を決めたときに頭の中で考えていたことを記録することが大切。 |
+ | (あとからこのコードを触る人の、定数の意味を調査・推測する時間を節約できる) | ||
< | < | ||
// 合理的な限界値。人間はこんなに読めない。 | // 合理的な限界値。人間はこんなに読めない。 |