こんばんは！マル太です。
前回は、リーダブルコードの第3章「誤解されない名前」についてまとめました。
今回は、第4章「美しさ」の内容について、アウトプットしていきたいと思います。
美しいコードを書くことの重要性
第4章では、コードの美しさについて解説されています。
美しいコードとは、単に見た目が整っているだけではありません。
論理的にも整理され、理解しやすく、読みやすいコードこそ、美しいコードだと著者は述べています。
美しいコードを書くことで、
・コードが読みやすくなる
・バグを見つけやすくなる
・修正しやすくなる
といったメリットがあります。
美しいコードを書くための具体的なテクニック
4章では、美しいコードを書くための具体的なテクニックとして、以下の点が挙げられています。
一貫性のあるレイアウト
・コードのレイアウトを一貫させることで、コードの構造を視覚的に把握しやすくなり、可読性が向上します。
・具体的には、インデントや空白、改行などを統一することで、コード全体に秩序を持たせることができます。
適切な改行
・適切な場所で改行することで、コードの各部分が明確に区切られ、読みやすくなります。
・特に、長い処理や複雑な条件式は、複数の行に分割することで、理解しやすくなります。
空白行を効果的に使う
・空白行を効果的に使うことで、コードの各セクションを視覚的に区切り、コードの構造を明確にすることができます。
・関連性の高いコードはまとめて記述し、セクション間には空白行を挿入することで、コードの可読性を高めることができます。
縦の線をまっすぐにする
・関連性の高いコードを縦に揃えることで、コードの構造を視覚的に表現し、理解しやすくすることができます。
・例えば、変数宣言や関数の引数を縦に揃えることで、コードの可読性が向上します。
※例えばこんな感じ⤵️
int age = 20;
String name = "田中太郎";
boolean is_adult = true;
int age = 20;
String name = "田中太郎";
boolean is_adult = true;
似たコードは近くに置く
・類似した処理を行うコードは、近くに配置することで、コードの関連性を明確にし、コードが読み易くなります。
・また、コードの重複を避けることができ、保守性も向上します。
変数は使う直前に宣言する
・変数は、使う直前に宣言することで、変数のスコープ（有効範囲）を限定し、コードの可読性を高めることができます。
・また、変数の値が変更される場所が分かりやすくなるため、バグの発生を抑制することができます。
※例えばこんな感じ⤵️
int value = 10;
// 他の処理... (value はここで使われていない)
// value を使う処理...
value = value + 5;
// 他の処理...
// value を使う処理...
int value = 10; // value を使う直前に宣言
value = value + 5;
良い例では、value を使う直前に宣言しています。
こうすることで、value がどこで使われているのか、値がどこで変更されるのかが、より明確になります。
関連する関数を近くに置く
・関連する関数は、近くに配置することで、コードの関連性を明確にし、理解しやすくすることができます。
・また、関数の呼び出し関係が分かりやすくなるため、コードの追跡が容易になります。
まとめ
今回は、「リーダブルコード」第4章「美しさ」の内容をまとめました。
美しいコードを書くことは、コードの可読性、保守性を高める上で非常に重要です。
4章で紹介されているテクニックを参考に、美しいコードを書くことを心がけていきたいですね。
次回は、第5章「コメントすべきことを知る」についてまとめます。