クリーンコード勉強まとめ
1 レキシカルスコープ
レキシカルスコープとは、変数や関数の有効範囲を決定するものです。コードの可読性と保守性を高めるためには、必要な範囲でのみ変数や関数を使うようにします。例えば、グローバル変数を減らし、関数内で必要な変数のみを定義します。
2. 変数の寿命と関心のある処理
変数の寿命を理解し、関心のある処理ごとに改行を入れることで、コードの可読性が向上します。また、関心のある処理はグループごとに記載することが推奨されます。
3. クラス設計
クラス名は、そのクラスが何をするものかを明確に示す名前にします。クラスの内部構造を知らないと使えないクラスにはしないようにしましょう。
4. 関数と副作用
関数は副作用のない純粋関数を目指し、決まった入力に対して決まった出力を返すように設計します。副作用のある関数や純粋関数は、それぞれまとめて整理しましょう。
5. 引数の管理
引数が多い場合はオブジェクトにまとめ、必要に応じて限定的にします。プログラムの挙動は基本的に引数を渡して、その結果として戻り値を返すのが一般的な挙動です。
6. ループの条件
ループの条件式が固定の場合は for、条件式がその時々で変化する場合は while を使いましょう。同じループ内で複数のことをしないように気をつけます(ケースバイケース)。
7. クリーンコードの基本
クリーンコードの基本として、結合度を目指し、疎結合を避けます。デッドコードには注意し、不要なコードは削除します。また、変更する必要のない関数を増やすために、コールバック関数や早期リターンを使用します。
このように、メモの内容を整理して各ポイントを説明することで、読みやすいコードを書くためのガイドラインを提供する記事が完成します。それぞれのセクションに具体的なコード例を追加すると、さらに理解しやすくなります。どのようなコード例を追加するかについてもアドバイスが必要であれば、お知らせください。
この記事が気に入ったらサポートをしてみませんか?