Zenn
👽

コードの整え方について

2025/03/31に公開
リーダブルコード
コード整形
tech

コーディングにおけるコード整形の重要性

チームで開発を行う上で、コードの整形は極めて重要です。ルールに沿ったコーディングを行うことで、保守性や改修のしやすさ、可読性が向上し、開発効率を高めることができます。本記事では、コーディングの際に意識すべき整形ルールについてまとめます。

命名規則

変数名や関数名を決定する際は、以下のルールを遵守しましょう。

  • 抽象的ではなく、具体的な名前を利用する
    • ❌ data → ✅ userList
    • ❌ value → ✅ totalAmount
  • 注意を喚起する名前にする
    • 例: isDangerous, requiresApproval
  • 単語を省略する場合は共通認識のもののみ
    • 例: id, url などの一般的な略語は可
  • メンバ変数とローカル変数の区別を明確にする
    • this.userName (クラスメンバ)
    • user_name (ローカル変数, アンダースコアを活用)
  • 変数名に単位をつける
    • 例: fileSizeMB, durationSec

コード整形

コードの可読性を高めるために、以下の整形手順を踏みましょう。

  • コードの順番に意味を持たせる
    • 変数の宣言、処理、出力の順序を明確にする。
  • 縦のラインを揃える
    • インデントや変数の代入位置を統一することで、視認性を向上させる。
  • コードを段落分けにする
    • まとまりのある処理ごとに適切に改行を入れる。

コメントの付け方

コメントを付ける際には、以下の点に留意します。

  • 一目で理解できるコードにはコメントをつけない
    • ❌ i++; // i を 1 増やす
    • ✅ // ユーザーリストのインデックスを進める
  • ソースコードの内容を要約するコメントをつける
    • 例: // 取得したデータをJSON形式に変換する
  • 自分の考えをコメントにする
    • 例: // パフォーマンスの観点から、このループの回数を減らすべきか要検討
  • 実装の動作例をコメントにする
    • 例:
      // 例: input = [1, 2, 3], output = [1, 4, 9]
function squareNumbers(arr) {
    return arr.map(x => x * x);
}

制御フローの設計

制御フローの設計では、以下のポイントを意識しましょう。

  • ネストを深くせず、こまめに return する
    • ❌ 深いネスト
      function checkUser(user) {
    if (user) {
        if (user.isActive) {
            return true;
        }
    }
    return false;
}
    • ✅ 早めの return を活用
      function checkUser(user) {
    if (!user) return false;
    if (!user.isActive) return false;
    return true;
}
  • 単純な条件は先に処理するガード節を利用する
    • if 文のネストを減らし、読みやすくする。
  • 三項演算子は可読性を低下させるため避ける
    • 例: return (isAdmin) ? "Admin" : "User"; よりも if-else を使う。
  • do-while の使用は避ける
    • do-while は意図しないループの実行を招きやすい。

まとめ

コード整形は、チーム開発を円滑に進める上で欠かせません。適切な命名、コードの整形、コメントの記述、制御フローの設計を意識することで、可読性が向上し、バグの発生を減らすことができます。日々のコーディングで、これらのルールを意識しながら開発を進めていきましょう！

参考書籍

Discussion