リーダブルコード 「鍵となる考え」
からなるほどと思ったところのピックアップです。
1.5 でもやるんだよ
- 「コードは他の人が最短時間で理解できるように書かなければいけない」
- 「他の人」というのは、半年後の「君自身」かもしれない
- 「最短時間で理解できるように」は効率化とかその他の目標とは競合しない
- 理解しやすいコードは優れた設計やテストにつながる
大変なことだ
でもやるんだよ
2章 名前に情報を詰め込む
- 名前に情報を詰め込む
- 明確な単語を選ぶ
- 名前が「他の意味と間違えられることはないだろうか?」と自問自答する
- 一貫性のあるスタイルは「正しい」スタイルよりも大切
- コメントの目的は書き手の意図を読み手に知らせること
- コードからわかることを書かない
- コードを理解するのに役立つものを書く
- 複数のものを指す可能性のある「それ」や「これ」などの代名詞を避ける
- 関数の動作はできるだけ正確に説明する
- コメントに含める入出力の実例を慎重に選ぶ
- コードの意図は、詳細レベルではなく、高レベルで記述する
7章 制御フローを読みやすくする
- 条件式の引数の並び順
- 「もし君が1年間で10万ドル以上稼げるならば」は自然
- 「もし君が18歳以上ならば」も自然
- しかし「もし18歳が君の年齢以下ならば」は不自然
- 行数を短くするよりも、「他の人」が理解するのにかかる時間を短くする。
12章 コードに思いを込める
- 解決策を言葉で説明する。
- ある大学の計算機センターにある方針。デバッグに悩む学生は、部屋の隅に置かれたテディベアに向かって説明しなければいけない。声に出して説明するだけで、学生は解決策が見つかる。この技法はラバーダッキングとも呼ばれる。
14章 テストとよみやすさ
最も読みやすいコードは何も書かれていないコードだ
解説
- 実際にやる
- 当たり前にする(続ける)
- コードで伝える
あなたには仲間が増える
参考記事
まとめ
自分で書いていて、ポエム味のある書き込みになってしまったなあと思いつつ、これは実際の本に書かれているキーポイント。共感しやすいものばかりだなと思いました。
以上参考になればさいわいです。