javascript - JavaScript コード規則 - オブジェクト宣言

Question

私は JavaScript スタイルガイドを開発しており、コード規則に適用できる唯一の規則は一貫性を保つことだと認識していますが、この規則を使用する主要なフレームワークがないため、この質問に興味があります。

オブジェクト/変数を宣言するときに、コロン/等号を垂直方向に配置することの利点と欠点は何ですか?

var a   = 1,
    ab  = 2,
    abc = 3;

var obj = {
    a   : 1,
    ab  : 2,
    abc : 3
};

score 2 · Accepted Answer

コードの可読性が向上します。それはそれについてです。

欠点は、必要以上のスペースがあるため、find を使用して変数の値を検索する場合です。variablename =そのため、実際にはとして定義されているため、を検索しても何も返されない場合がありvariablename[space][space][space]=ます。

score 0 · Accepted Answer

各変数を別々の行に置くと、それらが異なる変数であることが明確になり、読みやすさが主な要因になるため、もう一度読むとき (または他の人が読むとき) に役立ちます。

これは主に、何かを維持または変更するために別のプログラマーにコードを渡すことになる場合、または長い期間の後に戻ってきてコードを思い出せない場合に、長期的には利点です。

ほとんどの言語で同じです。

また、変数を相互に (および値を) 整列させると、コードが非常にきれいに整然と見えるようになりますが、これを行うのは非常に面倒であり、ほとんどの人はこれを行いません。行の先頭を揃えますが、その後は何も揃えません。

何かが変わって、すべてを再調整しなければならなくなったらどうなるか想像してみてください。

良くない。プログラミングに費やすことができる時間の無駄。

score 0 · Accepted Answer

コード内での検索は、明らかな欠点の 1 つです。

私があなたのシステムを継承した、またはそれに取り組まなければならないと想像してみてください。進行中、a変数が何であるかを理解する必要があります。システムには多数の行を含む巨大なコードベースがあるため、単純にスクロールしてすべての行を確認することはできません。

コード標準がvariable = 123である場合、単に「ファイル内検索」を実行できますvariable[SPACE]=[SPACE]。

これは、投稿した標準が悪い考えである可能性がある場所です。変数名と等号の間にいくつのスペースが入るかわかりません。もちろんa[SPACE]=、a[SPACE][SPACE]=、a[SPACE][SPACE][SPACE]=などを検索することもできますが、それははるかに困難です。

宣言を検索する唯一の方法 (「宣言の検索」ヘルパーのない生のコードエディターで) は、variable\s+=(1 つ以上のスペース) またはvariable\s*=(0 個以上のスペース)の正規表現検索を行うことです。正規表現検索機能を備えたエディターが必要です。

3 に答える 3