リーダブルコードを読んでわかったこと
以前リーダブルコードを軽く読んでいましたが、コードレビュー等を受けて色々な面で指摘されることが多かったので、改めてリーダブルコードを読んで、同じ指摘をされなく、レビューで単純なことで、修正するべき部分を減らしていきたいと思いました。リーダブルコードからわかったことや意識するようになったことをまとめたいと思います。
リーダブルコード
より良いコードを書くためのシンプルで実践的なテクニックがテーマとなっており、プログラマーがコードを書く上で基本となることが書かれています。
学んだこと
変数やメソッド名
変数名やメソッド名に多くの情報を持ち、意味がわかるような命名をする。
- 明確な単語の選択
- 汎用的な名前を避ける
- 重要な属性の追加
- スコープを考えた変数
- 文字の長さは長くても良いが、不要な単語はなくす
- 誤解をなくす名前
見やすさ
- 適切な改行
- 一貫性と意味のある並び
- 宣言のブロック化
- コードを段落に分割
- 条件式の引数の並び順
- ネストを浅くする
コメント
- コメントを付けずに名前の変更を行う
- 自分の考えの記録
- 定数に説明としてコメントを入れる
- 簡潔なコメントを書く
- 関数の動作を正確に記述する