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

可読性の高いコードを書くためには

可読性が低いコードの問題点

• 可読性の低いコードはバグが増え、生産性が低くなる。

• 可読性の低いコードは読みづらさからリファクタリングしづらくなる。　

可読性の高いコードを書くための要件

読みやすいコードの指標には複数の視点から評価する必要がある。

1. 単純
   真偽値を判定する際も、!=などをできるだけ使わないだけで読みやすいコードに繋がる。

2. 意図が明確
   flagなどの変数を使う場合もただ、flagと宣言するのだけでなく、isvisibleなどtrueの場合は表示され、falseの場合は表示されないなどある程度情報を読み取れるようにしておくだけで可読性の向上に繋がる。

3. 独立性が高い
   コードの規模が大きくなるにつれて全体の把握が難しくなるため、以下の2点を心がける必要がある。

   1. コードのまとまりの責任範囲を明確にする
      抽象度を高めてできるだけ、詳細にコードを読まずとも理解できるようにする。

   2. 依存関係を限定的にすること
      複数のclassや関数が依存し合うことで、コードが読みにくくなるため、依存は一方的にする。

4. 構造化されている
   一つのクラスにおいても数百行等になる場合もできるだけ、一連の処理をまとめて、補助的な関数にするなどして可読性の高いコードにする。

代表的なプログラミング原則

1. ボーイスカウトルール
   コードを修正する際は現状のコードより、読みやすくすることを心がける。

2. YAGNI
   機能は必要になった際に実装する。後で使用するからといって無駄な機能を加えないこと。

3. KISS
   実装は単純にする。一行で複数の処理を行うことで、開発時はきれいなコードに見えるが、リファクタリング時に読みづらいコードとなっている可能性がある。

4. 単一責任の原則(SOLID)
   クラスの責務を明確にする。一つのクラスに複数の機能を保有させないこと。

5. 早計な最適化は諸悪の根源
   最適化することでコードが複雑になり、可読性が下がることを避ける。

感想

個人的にはこのような可読性が高まるようなコードを書くことを意識しているつもりだが、意外と出来ていないことが多い。特に現場に入って、変数名に対しても細かくレビューをくださる方や、特にフィードバックがない方だと、開発に対する取り組み方が全く変わってくると思う。自分で気付けるのが第一であるため、コードを書き終わった際は改めて、じっくりとコードを読んでいくことが重要であると感じた。