2023年11月27日

コーディングスタイル

コードはできるだけ綺麗で読みやすいものでなければなりません。

複雑なタスクを正しくかつ読みやすい形でコード化する、それはまさにプログラミングの極意です。優れたコーディングスタイルは、そのための大きな助けとなるのです。

構文

下記は、いくつかの推奨ルールを示したチートシートです(詳細は後述):

では、これらのルールと理由について詳細を説明します。

“しなければならない” というルールはありません。

変えられないものはありません。これらはスタイルの好みであり、宗教的な教義ではありません。

波括弧

ほとんどのJavaScriptのプロジェクトでは、波括弧は新しい行ではなく、同じ行に書かれます。いわゆる “エジプト” スタイルです。また開始の括弧の前にはスペースがあります。

このようになります:

if (condition) {
  // do this
  // ...and that
  // ...and that
}

if (condition) doSomething() のような1行の構造も重要なエッジケースです。すべて括弧を使うべきでしょうか?

次にいくつか注釈付きでパターンを示します。あなた自身でその可読性を判断してみてください:

  1. 😠 初心者はこのようにすることがありますが、よくありません! 波括弧は必要ありません:
    if (n < 0) {alert(`Power ${n} is not supported`);}
  2. 😠 括弧なしで別の行に分割しています。行を追加するときにミスを起こしやすいので、決して行わないでください。:
    if (n < 0)
      alert(`Power ${n} is not supported`);
  3. 😏 括弧なしの1行。短い場合は許容されます:
    if (n < 0) alert(`Power ${n} is not supported`);
  4. 😃 ベストな形式:
    if (n < 0) {
      alert(`Power ${n} is not supported`);
    }

非常に簡潔なコードであれば、if (cond) return null のような1行の形式は許容されます。しかしながら、コードブロック(最後のバリアント)の方が、通常はより読みやすい形式です。

行の長さ

横に長いコードを読むのが好きな人はいません。それらを分割するのがベストプラクティスです。

例:

// バッククォート ` を使うと、文字列を複数行に分割することができます
let str = `
  ECMA International's TC39 is a group of JavaScript developers,
  implementers, academics, and more, collaborating with the community
  to maintain and evolve the definition of JavaScript.
`;

また、if 文の場合は:

if (
  id === 123 &&
  moonPhase === 'Waning Gibbous' &&
  zodiacSign === 'Libra'
) {
  letTheSorceryBegin();
}

1行の最大長は、チームレベルで合意しておくべきでしょう。通常は 80 または 120 文字です。

インデント

2つのタイプのインデントがあります。:

  • 水平なインデント: 2(4)個のスペース

    水平なインデントは 2 または 4 つのスペース、もしくは “タブ” 記号(キー Tab)を使います。どれを選ぶかは好みの問題です。最近はスペースが一般的です。

    タブよりもスペースの方がよい点の1つは、スペースは “タブ” 記号よりもより柔軟なインデントの設定ができることです。

    例えば、このように、開始の括弧に対して引数を並べることができます:

    show(parameters,
         aligned, // 左から 5 つのスペース
         one,
         after,
         another
      ) {
      // ...
    }
  • 垂直のインデント: コードを論理ブロックに分割するための空行

    1つの関数であっても、多くの場合、論理的なブロックに分割可能です。下の例では、変数の初期化、メインのループ、結果の返却を縦方向に分割しています。:

    function pow(x, n) {
      let result = 1;
      //              <--
      for (let i = 0; i < n; i++) {
        result *= x;
      }
      //              <--
      return result;
    }

    コードがより読みやすくするために新しい行を挿入しましょう。垂直インデントなしで、コードの行が9行を超えるべきではありません。

セミコロン

セミコロンは、たとえ省略できるとしても各文の末尾に存在するべきです。

セミコロンが本当にオプションで、ほとんど使われない言語もあります。また、JavaScriptでは改行がセミコロンとして解釈されないケースがあり、プログラミングエラーの可能性を残します。詳細については、チャプターコード構造を参照してください。

JavaScript のプログラマとしてより成熟するにつれて、StandardJS のようにセミコロンなしのスタイルを選ぶかもしれません。それ以外の場合、起こりうる落とし穴を避けるためセミコロンを使用するのが最善です。開発者の大多数はセミコロンをつけています。

ネストレベル

コードはネストし過ぎないようにしてください。

例えば、ループで余計なネストを避けるために "continue"ディレクティブを使うことは、時には良いアイデアです。

また、このようにネストした if を追加する代わりに:

for (let i = 0; i < 10; i++) {
  if (cond) {
    ... // <- 1つネストレベルが増える
  }
}

このように書けます:

for (let i = 0; i < 10; i++) {
  if (!cond) continue;
  ...  // <- 余分なネストレベルなし
}

同様のことが、if/else や return でもできます。

例えば、下の2つの構造は同一です。

1つ目:

function pow(x, n) {
  if (n < 0) {
    alert("Negative 'n' not supported");
  } else {
    let result = 1;

    for (let i = 0; i < n; i++) {
      result *= x;
    }

    return result;
  }
}

2つ目: