2022年11月15日火曜日

読みやすいコードのガイドライン

全体的にソフトウェアに関連することを薄く広く扱っている。
その上で、それらのソフトウェア開発の常識が読みやすさにどう影響するかを書いてくれている。
ソフトウェア開発をある程度経験している人が、読むと良いのではないかと思う。
悪い例が数多く乗っているので、ある程度の経験がないと、悪いコードが書かれがちなこととかが腹落ちしないのはないかと思うので、社会人向けの本だと思います。

手元においておいて、コーディングで迷ったらパラパラめくって見てみて、掘り下げたいものがあれば掘り下げるように使い方をするのが良いと思う。

(目次)
第1章 可読性の高いコードを書くために
  1-1 生産性への恩恵
  1-2 可読性の高いコードを書くための要件
  1-3 代表的なプログラミング原則
  1-4 まとめ
第2章 命名
  2-1 命名に使う文法
  2-2 名前の示す内容
  2-3 単語の選択
  2-4 言語・プラットフォーム・プロダクトの規約
  2-5 まとめ
第3章 コメント
  3-1 コメントの種類と目的
  3-2 ドキュメンテーション
  3-3 非形式的なコメント
  3-4 まとめ
第4章 状態
  4-1 可変の値の方が有用なケース
  4-2 複数の変数間の直交性
  4-3 状態遷移の設計
  4-4 まとめ
第5章 関数
  5-1 関数の責任
  5-2 関数の流れ
  5-3まとめ
第6章 依存関係
  6-1 依存の強さ:結合度
  6-2 依存の方向
  6-3 依存の重複
  6-4 依存の明示性
  6-5 まとめ
第7章 コードレビュー
  7-1 レビューイの注意点1:レビューしやすいプルリクエストを作る
  7-2 レビューイの注意点2:コメントを適用する方法
  7-3 レビューアの注意点1:レビュー実施時の基本原則
  7-4 レビューアの注意点2:コメントの内容
  7-5まとめ

0 件のコメント:

コメントを投稿