自己文書化JavaScriptを書く15の方法

自己文書化されたJavaScriptコードを書くための重要なポイント

コアスキル

構造化されたテクノロジー：

コードを関数に移動し、条件付き式を関数に置き換え、純粋な関数を使用してコードをより明確かつ理解しやすくします。
• ネーミング条約：
名前の読みやすさを向上させるために、意味のある名前の名前の変数、関数、クラス。
• 構文スキル：
構文技術の使用を避け、名前のある定数を使用してコードをより明確にします。
• 注意を払ってコードを抽出します：
短い関数を追求してコードを過剰抽出しないようにします。これにより、コードの理解可能性が低下します。
技術的概要

自己文書化されたコードを3つのカテゴリに分割します：

構造：コードまたはディレクトリの構造を使用して、コードの目的を明確にします。

• name関連：たとえば、関数または変数の命名。
• 構文関連：言語機能を使用（または回避）して、コードをより明確にします。
• 構造化された技術

コードを関数に移動します：

既存のコードを新しい関数に移動して、その関数をより明確にします。たとえば、

は次のように書き換えることができます
• var width = (value - 0.5) * 16;

条件付き式を関数に置き換えます。

var width = emToPixels(value);

function emToPixels(ems) {
    return (ems - 0.5) * 16;
}

複雑な条件ステートメントを関数に変換して、読みやすさを向上させます。

• 式を変数に置き換えます：

  複雑な式を複数の変数に分解して、理解度を向上させます。

• クラスおよびモジュールインターフェイス：

  クラスのパブリックメソッドとプロパティは、使用法のドキュメントとして使用できます。明確なインターフェイスは、クラスの使用を直接反映できます。

• コードのグループ化：

  関連するコードのグループ化は、コードの間に関連性があり、メンテナンスを促進することを示している可能性があります。

• 純粋な関数の使用：

  純粋な関数は、出力が入力パラメーターのみに依存し、副作用がないため、理解しやすいです。

• ディレクトリとファイル構造：

  コードの検索と理解を促進するために、プロジェクトの既存の命名規則に従ってファイルとディレクトリを整理します。

• 命名スキル

関数の名前：

アクティブな音声で動詞を使用し、戻り値を明示的に示します。 「ハンドル」や「管理」などのあいまいな単語の使用は避けてください。

• 変数の名前：

  意味のある名前を使用して、ユニットを指定します（例：
）。略語の使用は避けてください。

• 確立された命名規則を順守してください：プロジェクトで一貫した命名スタイルを維持します。

• 意味のあるエラーメッセージの使用：コードによってスローされたエラーメッセージが記述的であり、エラーを引き起こした関連情報が含まれていることを確認します。

文法スキル

• 文法のヒントの使用は避けてください：imTricky && doMagic();などの理解しにくい文法のヒントを使用しないでください。 if

• 名前付き定数を使用して魔法の値を回避します。コードの読みやすさと保守性を向上させるために、魔法の値の代わりに名前の指定定数を使用します。

• ブールフラグを避けてください：ブールフラグは、コードの理解を困難にする可能性があり、より明確なアプローチを考慮する必要があります。

• 言語機能を最大限に活用してください。アレイイテレーション方法などの言語で提供される機能を使用して、コードをより簡潔で理解しやすくします。

antiモード

• 短い関数のコードの過剰抽出：コードの過剰抽出を避けて、コードの理解度を低下させる可能性があります。

• 強制しないでください：メソッドが適切でない場合は、それを使用するように強制しないでください。

概要

自己文書化されたコードを書くことで、コードの保守性を大幅に改善し、コメントの必要性を減らすことができます。ただし、自己文書化されたコードは、ドキュメントやコメントを完全に置き換えることはできません。 優れた注釈とAPIドキュメントは、大規模なプロジェクトにとって依然として重要です。

以上が自己文書化JavaScriptを書く15の方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。