來源：網易郵箱
在多年開發郵箱webmail過程中，網易郵箱前端團隊積累了不少心得體會，我們開發了很多基礎js庫，實現了大量前端效果元件，開發了成熟的opoa框架以及api元件，在此向大家做一些分享。今天想先和大家聊聊javascript的編碼規範。
總所周知，javascript是一種語法極其靈活的語言。javascript在設計之初就只是用來為HTML新增動態效果的。由於他動態，弱型別等特性，以及不同瀏覽器的相容性問題，造成了開發成本要比java等語言要高很多。正因為它太靈活，我們制定了適用於網易郵箱的javascript編碼規範，儘可能多的降低由於語法靈活造成的問題。以下將具體介紹：
1. 變數命名規範
變數名包括全域性變數，區域性變數，類變數，函式引數等等，他們都屬於這一類。
基本規範
變數命名都以型別字首+有意義的單片語成，單詞首字母都需要大寫。例如：sUserName，nCount。
字首規範
每個區域性變數都需要有一個型別字首，按照型別可以分為：
s：表示字串。例如：sName，sHtml；
n：表示數字。例如：nPage，nTotal；
b：表示邏輯。例如：bChecked，bHasLogin；
a：表示陣列。例如：aList，aGroup；
r：表示正規表示式。例如：rDomain，rEmail；
f：表示函式。例如：fGetHtml，fInit；
o：表示以上未涉及到的其他物件，例如：oButton，oDate；
例外情況：
1：作用域不大臨時變數可以簡寫，比如：str，num，bol，obj，fun，arr。
2：迴圈變數可以簡寫，比如：i，j，k等。
為什麼需要這樣強制定義變數字首？正式因為javascript是弱語言造成的。在定義大量變數的時候，我們需要很明確的知道當前變數是什麼屬性，如果只通過普通單詞，是很難區分的。
例如：
|
1 2 3 4 5 6 |
var group = []; group.name = 'myGroup'; /**** some code ***/ //這時候你還能一眼就看出來group是什麼嗎？ |
又例如：
|
1 2 3 4 5 6 7 8 9 10 |
var checked = false; var check = function(){ return true; } /** some code **/ if(check){//可能將checked寫成check，由於不能很快速的發現check是函式，造成邏輯錯誤 //do some thing } |
如果我們寫成：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
var bChecked = false; var fCheck = function(){ return true; } /** some code **/ if(bChecked){ // do some thing } if(fCheck()){ // do other thing } |
就清楚很多了。
全域性變數以及常量規範
網易郵箱前端是基於“類”的概念來來開發javascript的（稍後會專門介紹），每個類定義都是在一個閉包函式中，除了在window下有類的定義而外，只允許有兩種變數定義在全域性，那就是全域性變數和常量。
全域性變數使用g作為字首，定義在window下。例如gUserName，gLoginTime。
某些作為不允許修改值的變數認為是常量，全部字母都大寫。例如：COPYRIGHT，PI。常量可以存在於函式中，也可以存在於全域性。
看個例子就 很容易明白為什麼要這樣定義了：
|
1 2 3 4 5 |
var userName = "dongua"; function checkName(userName){ //存在函式引數userName以及全域性變數userName,如果要比較兩個值是否相等，必需寫為 return window.userName == userName } |
如果使用了全域性變數的字首，就十分清晰了。
2. 函式命名規範
統一使用動詞或者動詞[＋名詞]形式，例如：fGetVersion()，fSubmitForm()，fInit()；涉及返回邏輯值的函式可以使用is，has等表示邏輯的詞語代替動詞。
如果有內部函式，使用__f+動詞[+名詞]形式，內部函式必需在函式最後定義。例如：
|
1 2 3 4 5 6 7 8 9 10 11 12 |
function fGetNumber(nTotal){ if(nTotal<100){ nTotal = 100; } return __fAdd(nTotal); function __fAdd(nNumber){ nNumber++; return nNumber; } } alert(fGetNumber(30));//alert 101 |
物件方法實現
物件方法命名使用 f+物件類名+動詞[+名詞]形式；例如 fAddressGetEmail
事件響應函式
某事件響應函式命名方式為觸發事件物件名＋事件名或者模組名＋觸發事件物件名＋事件名，例如：fDivClick()，fAddressSubmitButtonClick()
3.其他注意事項
1：所有命名最好使用英語表示。
2：所有變數名應該明確而必要，儘量避免不必要的容易混淆的縮寫。
3：netease.events.mouse.Handler，而不是 netease.events.mouse.MouseEventHandler。
4：對應的方法應該使用對應的動詞，例如：get/set, add/remove, create/destroy, start/stop, insert/delete, begin/end。
5：應該避免雙重否定意義的變數，例如：bIsNotError, bIsNotFound，不可取。
6：變數應該在最小的範圍內定義，並儘可能的保持最少的活動時間。
7：迴圈變數最好在迴圈中定義。例如for(var i=0,m=10;i<m;i++){ do something}。
8：儘量避免複雜的條件語句，可以使用臨時的boolean變數代替。
9：一定要避免在條件中執行語句，例如：if((i=3)>2){}，不可取。
10：不要在程式碼中重複使用相同意義的數字，用一個變數代替，比如 nTotal=100; num= total。