ホームページ  >  記事  >  ウェブフロントエンド  >  JavaScript コーディング スタイル ガイドの詳細な紹介

JavaScript コーディング スタイル ガイドの詳細な紹介

黄舟
黄舟オリジナル
2017-03-13 16:52:121455ブラウズ

1. 基本形式

インデント

エディタが自動的に変換するように、タブ = 4 スペースを使用することをお勧めします

セミコロン

を防ぐためにセミコロンを省略しないでください。 ASI (セミコロンを自動的に挿入) エラー

行幅

コードの各行は 80 文字を超えてはなりません。長すぎる場合は、演算子を使用して手動で改行する必要があります

改行

。演算子は前の行の最後にあり、次の行はインデントされます レベル 2 に進み、代入文の場合は、等号の後の部分にも配置する必要があります

空白行

関数宣言と関数宣言、変数宣言と関数宣言、関数内のロジック ブロックの間にはスペースが必要です。行分離

作者の Nicholas は、Flow Control ブロックの先頭に空行を残すことも提案しましたが、例では与えられた内容はあまり明確ではありません

命名

  • 変数名/関数名: Camel (キャメルケース) ルール、最初の単語の最初の文字は小文字、後続の単語の最初の文字は大文字、残りは小文字

  • 定数名前: C言語式、すべて大文字、アンダースコアの単語分割

  • コンストラクター: Pascalルール、すべての単語最初の文字は大文字で、残りは小文字です

リテラル

追伸 に非常に古典的な説明があります。この本:

適切に書かれたコメントはコードのストーリーを伝えるのに役立ちます。

すべて

他の開発者が最初を聞く必要なくストーリーの一部に参加できるようにする必要があります。

一行コメント

終わり行: コードを 1 レベルのインデントで区切ります。// の後にスペースが必要です

  • 単独の行: 以下のコメントに使用され、コメントされたコードと同じインデントを維持します

  • 行頭:複数行のコードをコメントするために使用されます

  • 複数行のコメント

大きなコメントをラップするために使用され、

/*
 * comment line1
 * comment line2
 */
などの

Eclipse

スタイルを推奨します注:

複数行 空白行を残しますコメントの上

  • *アスタリスクの後にはスペースを入れてください

  • 複数行のコメントは少なくとも3行にする必要があります(最初と最後の行の後にコメントがないため)

  • コメントを追加する場所

意味不明なコード

  • 意図的ですが、何かが間違っているようです

  • ブラウザ用のハック

  • ドキュメントのコメント

各関数にコメントを追加する必要があります、推奨される Eclipse スタイルなど、関数の説明、パラメーター、戻り値、スローされたエラーなどが含まれます:

/**
 * 添加指定元素到默认数组
 *
 * @method add
 * @param {Number} 将要添加的元素
 * @return {Boolean} 添加成功/失败
 * @throw {TypeError} 参数类型不匹配
 */
function add(item){
    if(typeof item === "number"){
        arr.push(item)
    }
    else{
        throw new TypeError();
    }
}
3. ステートメントと式

中括弧の配置

推奨される行末スタイル、非推奨 線スタイル

ステートメントのスペースをブロックする

if の後の括弧の前後にスペースがあります。例:

if (expr) {
    code
}

switch ステートメント

インデント: case は switch、break

インデントと揃えられます レベル 1 に移動します

withステートメント

不要

forループ

ホスティング (プロモーション) によって引き起こされるバグを避けるために、for ループの初期化部分で使用される変数を含め、すべての変数を関数本体の先頭で宣言する必要があります (グローバル変数はブロックされる可能性があります)

for-in ループ

これをトラバーサル配列には使用しないでください。使用するときは、プロトタイププロパティを意図的にトラバースする場合は、コメントを使用して説明する必要があります

4. 変数、関数、演算子

変数宣言

関数本体 = 変数宣言 + 関数宣言 + 論理ステートメント。各部分を空行で区切ります

関数宣言

使用する前に最初に宣言してください。関数宣言をif分岐に入れないでください。ブラウザによって理解が異なり、ESは標準

関数呼び出しを提供しません

いいえブロックステートメントとの混同を避けるため、括弧の前後にスペースを入れます

匿名関数即時実行

匿名関数宣言との混乱を避けるために、すぐに実行される匿名関数を括弧で囲みます

厳密モード

オンにしないグローバルスコープで厳密モードをオンにする場合は、関数内でのみオンにします。複数の関数をオンにした場合は、匿名関数を使用して

と等しいかどうかを判断するだけです。 === と !== を使用します

eval

eval() と new Function() を使用せず、匿名関数を使用して setTimeout() と setInterval() を最適化します

基本的なパッケージ化タイプ

Don new Boolean()、new String()、new Number() は使用しないでください

以上がJavaScript コーディング スタイル ガイドの詳細な紹介の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。

声明:
この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。