JS命名規範、引用規範
4664 ワード
今日記録はJS命名規範、引用規範を使用し、統一的な符号化規範を使用してコードを書くことはJSコードの可読性を高めることができ、後期のメンテナンスと拡張に有利であり、チーム開発に有利である.
JSコードの参照仕様
JSコードはHTMLファイルに埋め込まれることを避けるべきで、採用によって別途*とする.JSのファイルを で読み込み、なぜなら、ブラウザのCache(キャッシュ)を利用してページのリフレッシュを回避して再ロードできるため、JSコードには必要なく、逆にファイルの転送量を増やしてしまうからである.ここでは、JSコードを複数のファイルに分けて開く方法を提案し、JSコードの修正による重複呼び出しを減らすことができるという利点がある.
命名規範の原則は、最小のアルファベットで最も理解しやすい意味を達成することである.JSコードの命名規範:
1、変数宣言:
開発では、すべての変数が使用前に宣言されなければなりません.JavaScriptでは必ずしもそうする必要はありませんが、コードを読みやすくし、宣言されていないため全局にコンパイルされた変数をよく見つけることができるので、お勧めします.
変数を宣言するときにvarを宣言の最前部に配置し、各変数を単独で1行にし、その後に注釈を付け、アルファベット順に並べ替えます.
2、関数の宣言:
すべての関数は使用前に宣言する必要があります.内部関数の宣言はvarの後に付いており、それらの変数が関数の範囲内であることを判断するのに役立ちます.
関数名と「(」の左括弧の間にスペースがあるべきではなく、右括弧")」と文主体の開始「{」の大括弧の間にスペースを1つ空け、プログラム主体はTabではなく4つのスペースをインデントし、関数主体の最後の「}」カッコは、関数で宣言された行の先頭に揃えます.例は次のとおりです.
JSの作成ではグローバル関数は使用しないようにしてください.
3、コメント
最後にやはりコード注釈を話して、符号化の過程の中で注釈をけちけちしないでください、良好なコード注釈は後日の自分あるいは読者にコードを理解する近道を提供することができます.同時に注釈を書くときは、あまり冗長にしたり、個人的な感情を持って代わらないでください.また、注釈のタイムリーな更新も重要です.誤ったコード注釈は、自分や読者にコードを理解する近道を提供することができないだけでなく、誤りをもたらす可能性があります.最後に、注釈を書く意味があり、後日の自分や読者に貴重な時間を次の例に浪費させないようにします.
JSコードの参照仕様
JSコードはHTMLファイルに埋め込まれることを避けるべきで、採用によって別途*とする.JSのファイルを
命名規範の原則は、最小のアルファベットで最も理解しやすい意味を達成することである.JSコードの命名規範:
1、変数宣言:
開発では、すべての変数が使用前に宣言されなければなりません.JavaScriptでは必ずしもそうする必要はありませんが、コードを読みやすくし、宣言されていないため全局にコンパイルされた変数をよく見つけることができるので、お勧めします.
変数を宣言するときにvarを宣言の最前部に配置し、各変数を単独で1行にし、その後に注釈を付け、アルファベット順に並べ替えます.
var ageValue, //
nameValue, //
sexValue; //
ネーミング仕様はC#のCamel(ラクダネーミング仕様)を参照しています.2、関数の宣言:
すべての関数は使用前に宣言する必要があります.内部関数の宣言はvarの後に付いており、それらの変数が関数の範囲内であることを判断するのに役立ちます.
関数名と「(」の左括弧の間にスペースがあるべきではなく、右括弧")」と文主体の開始「{」の大括弧の間にスペースを1つ空け、プログラム主体はTabではなく4つのスペースをインデントし、関数主体の最後の「}」カッコは、関数で宣言された行の先頭に揃えます.例は次のとおりです.
function createXmlHttp() {
/// <summary> xmlhttp </summary>
if (window.XMLHttpRequest) {
return new XMLHttpRequest();
} else if (window.ActiveXObject) {
return new ActiveXObject("msxml2.xmlHttp");
}
}
関数が匿名の関数である場合、functionと「(」左かっこの間にスペースがあるため、コード読者にfunctionという関数を宣言したと誤認されやすい.// String
String.prototype.trim = function (str) {
var reg = / \t/ig;
//return reg.replace(str,"");
return str.replace(reg, "");
}
JSの作成ではグローバル関数は使用しないようにしてください.
3、コメント
最後にやはりコード注釈を話して、符号化の過程の中で注釈をけちけちしないでください、良好なコード注釈は後日の自分あるいは読者にコードを理解する近道を提供することができます.同時に注釈を書くときは、あまり冗長にしたり、個人的な感情を持って代わらないでください.また、注釈のタイムリーな更新も重要です.誤ったコード注釈は、自分や読者にコードを理解する近道を提供することができないだけでなく、誤りをもたらす可能性があります.最後に、注釈を書く意味があり、後日の自分や読者に貴重な時間を次の例に浪費させないようにします.
int index ++;// index
:http://www.15ae.com/archive/2012-02/27022329259.html