綺麗なコードを書くための重要なヒント

綺麗なコードを書くための重要なヒント

source: https://app.daily.dev/posts/essential-tips-for-writing-clean-code-jevorrezm

わかりやすい変数名を使用する

• 意味がわかりやすく、プロジェクト全体で一貫したネーミングを採用する。

コードレビューにAIを活用する

• ChatGPT, GitHub Copilotなどをコードレビューに活用する。
• 修正のサジェストやベストプラクティスを示してくれる。
  参考: https://zenn.dev/ncdc/articles/7807f5b6e3ee88

不必要なコメントは最小限にする

• 役立つコメント以外は避ける。
• コード自体が自明であることを目指す。
• What？ではなくWhy？を書く。

DRY(Don't Repeat Yourself)原則に従う

• 可能な限りコードの重複は減らし、再利用可能にする。
• 保守性・エラーリスク軽減につながる。

一貫したフォーマットを採用する

• プロジェクト全体で一貫したフォーマット形式を採用する。
• 可読性・保守性が向上する。

関数を細分化する

• 1つの関数は1つの目的にする。
• 可読性のみならず、デバッグ・テストがしやすくなる。

ファイルを効果的に整理する

• ファイル・ディレクトリの構造を論理的にメンテする。
• 必要なファイルに素早くアクセスできる。

値のハードコードは避ける

• コードに直接書かず、外部定数・設定ファイルを使う。
• 更新を容易にし、エラーリスクを低減する。

単一責任の原則を適用する

• 関数・クラスは1つの責任を持つようにする。
• 理解しやすくメンテしやすくなる。