Zenn
📛

長い条件式を改行する際のベストプラクティス

2024/12/12に公開
if
tech

長い条件式を改行する際のベストプラクティスについて、以下のポイントを考慮すると良いでしょう。

1. 論理演算子の位置

前置きスタイル

  • 論理演算子を前に置く: 条件式が長くなる場合、論理演算子（&&や||）を行の先頭に置くスタイルを採用することが推奨されます。これにより、条件が追加または削除された際に、変更がその行だけで済むため、コードの可読性が向上します。
if ($condition1
    && $condition2
    && $condition3) {
    // 処理
}

後置きスタイル

  • 後ろに置く場合の注意: 論理演算子を行末に置くと、条件が増減した際に前の行も編集する必要が出てきてしまいます。これにより、差分（diff）が増え、可読性が低下することがあります。
if ($condition1 &&
    $condition2 &&
    $condition3) {
    // 処理
}

2. インデントと整形

一貫したインデント

  • インデントを統一: 各条件を新しい行に書いた場合は、適切なインデントを使用して視覚的にグループ化します。これにより、条件がどのように組み合わさっているかが明確になります。
if ($condition1
    && $condition2
    && $condition3) {
    // 処理
}

3. 読みやすさの向上

自然な読み方

  • 自然な読み方を意識: 条件式を読み上げるとき、「条件1、かつ条件2、かつ条件3」と読む方が自然です。このため、前置きスタイルは論理的にも読みやすさを向上させます。

4. コードの制限

行の長さ制限

  • 行の長さを制限: 一般的には、コードの行は80文字から120文字以内に収めることが推奨されます。これにより、コード全体の可読性が向上し、スクロールなしで見やすくなります。

まとめ

長い条件式を扱う際は、論理演算子を前に置くスタイルを採用し、一貫したインデントと行の長さ制限を設けることで可読性を高めることができます。これらのベストプラクティスに従うことで、コードのメンテナンス性も向上します。

Discussion