1. Javascript程式碼應符合Douban-JSLint檢定標準
1-1. 語句必須都有分號結尾,除了for, function, if, switch, try, while
1-2 . 只有長語句可以考慮斷行,如:
TEMPL_SONGLIST.replace('{TABLE}', da['results'])
.replace('{PREV_NUM}', prev)
.replace('{NEXT_NUM}', next)
.replace('{CURRENT_NUM}', current)
.replace('{TOTAL_NUM}', da.page_total);
為了避免和JSLint的檢定機制衝突,「.」或「+」這類運算子放在行尾,上面程式碼要改為:
TEMPL_SONGLIST.replace('{TABLE}', da['results' ]).
replace('{PREV_NUM}', prev).
replace('{NEXT_NUM}', next).
replace('{CURRENT_NUM}', current).
replace( '{TOTAL_NUM}', da.page_total);
1-3. 避免額外的逗號。如:var arr = [1,2,3,];
1-4. 所有的循環體和判斷體都需要用"{}"括起來。如:
錯誤:
if (condition)
statement;
或
if (condition) statement;
對:
if (condition) {
statement; 或
if (condition) { statement; }
1-5. for-in循環體中必須用hasOwnProperty方法檢查成員是否為自身成員。避免來自原型鏈上的污染。
1-6. 變數宣告。變數宣告應放在function的最上面。避免使用未宣告的變數。
錯:
if (n > 0) {
var isvalid = true;
對:
var isvalid;
if (n > 0) {
isvalid = true;
}
1-7. 不要使用with, void, evil。
1-8. 使用嚴格的條件判斷子。用===代替==,用!==代替!=。
1-9. 下面類型的物件不建議用new建構:new Number, new String, new Boolean, new Object(用{}取代), new Array(用[]代替)。
1-10. 引用物件成員以obj.prop1取代obj[“prop1”],除非屬性名稱是變數。
註:Douban-JSLint是定制的JSLint
註:如果模組程式碼中,使用其它全域變數想跳過JSLint的檢查,可以在該檔案中加入聲明,如:
2. Javascript命名規則
2-1. 建構器的首字母大寫。如:
function Dialog (config) {
statement;
} var dlg = new Dialog({...});
2-2. 物件的屬性或方法名稱採用小駝峰式(lower camel-case),如"init", "bindEvent", "updatePosition":
Dialog.prototype = {
init: function () {},
bindEvent: function () {},
updatePosition: function () {} };
2-3. 私有變數名稱以底線開頭。如:"_current", "_defaultConfig"
2-4. 常數名全部大寫,單字間用底線分隔。如:「CSS_BTN_CLOSE」, "TXT_LOADING"
2-5. 變數名稱的前綴:
Prefix
Element
Example
integer
nVariableName
i,j,k,m,n, etc. *
integer as counter/iterator
(for i=0 ; i
string
sVariableName
object
oObjectName
is, can, has
boolean
[Boolean name]ConditionName
event method
event attachment
[event type]_MethodName
accessor method
getMethodName
accessor method
setMethodName
Note: Only a counter/iterator should use a single-letter designation.
3. 程式碼格式化要求
3-1. 語句中的必要空格和縮排
3-1-1. 用來包含語句的"()"前後需要跟空格,諸如: if / for / while / switch ( statements ) { … } 等
3-1-2. "="前後需要跟空格
3-1-3. 陣列成員間的","後面要跟空格
不好:
for (t in selected) { if (!hash[t]) deselect(t) }
好:
for ( t in selected ) {
if ( !hash[t] ) {
deselect(t); }
3-2. 長語句採用斷行:
不好:
TEMPL_SONGLIST.replace('{TABLE}', da['results']).replace('{PREV_NUM}', prev).replace('{NEXT_NUM }', next).replace('{CURRENT_NUM}', current).replace('{TOTAL_NUM}', da.page_total);
好:
TEMPL_SONGLIST.replace('{ TABLE}', da['results']).
replace('{PREV_NUM}', prev).
replace('{NEXT_NUM}', next).
replace('{CURRENT_NUM}' , current).
replace('{TOTAL_NUM}', da.page_total);
3-3. 格式化物件參數:
不好:
embedSWF(id, { url: '/swf/player30792.swf?url=' el.href, width: 261, height: 30, params: { wmode:'transparent' }, attributes: { id: "player-sample" i, name: "player-sample" i }});
好: