javascript代碼規(guī)范

《javascript代碼規(guī)范》由會(huì)員上傳分享，免費(fèi)在線閱讀，更多相關(guān)內(nèi)容在應(yīng)用文檔-天天文庫(kù)。

1、javascript代碼規(guī)范[鍵入文檔副標(biāo)題]李博[選取日期]1.14目錄1.JS文件基本規(guī)范21.1.JavaScript文件21.2.版權(quán)和版本的聲明21.3.編碼格式22.程序的版式32.1.空格32.2.縮進(jìn)32.3.行寬42.4.注釋42.5.變量聲明52.6.方法聲明62.7.命名規(guī)則83.語(yǔ)句的規(guī)范83.1.簡(jiǎn)單語(yǔ)句83.2.復(fù)雜語(yǔ)句83.3.語(yǔ)句實(shí)例93.3.1.return語(yǔ)句93.3.2.if語(yǔ)句93.3.3.for語(yǔ)句93.3.4.while語(yǔ)句103.3.5.do語(yǔ)句103.3.6.sw

2、itch語(yǔ)句113.3.7.try語(yǔ)句113.3.8.continue語(yǔ)句123.3.9.with語(yǔ)句123.4.額外建議123.4.1.{}和[]12143.4.2.逗號(hào)操作符123.4.3.塊作用域123.4.4.賦值表達(dá)式123.4.5.===和!==操作符123.4.6.令人混淆的加和減133.4.7.邪惡的eval1314JS文件基本規(guī)范1.1.JavaScript文件JavaScript程序應(yīng)該作為一個(gè)單獨(dú)的.js文件存儲(chǔ)和發(fā)布。JavaScript代碼不應(yīng)該嵌入在HTML文件里，除非那些代碼是一個(gè)

3、單獨(dú)的會(huì)話特有的。HTML里的JavaScript代碼大大增加了頁(yè)面的大小，并且很難通過緩存和壓縮來緩解。標(biāo)簽應(yīng)該在body里越靠后的位置越好。這減少了由于加載script而導(dǎo)致的其它頁(yè)面組件的延遲。沒有必要使用language或者type屬性。由服務(wù)器而不是script標(biāo)簽來決定MIME類型。1.2.版權(quán)和版本的聲明版權(quán)和版本的聲明位于文件的開頭，以注釋的結(jié)構(gòu)出現(xiàn)，如圖表11所示：/**可視化網(wǎng)頁(yè)編輯器***摘要：簡(jiǎn)要敘述本文件內(nèi)容以及功能**當(dāng)前版本：1.

4、1*作者：輸入作者（或修改者）名字*完成日期：**年*月*日**取代版本：1.0*原作者：輸入原作者（或修改者）名字*完成日期：**年*月*日*/圖表11版權(quán)和版本聲明1.3.編碼格式14所有js文件（以及其他html、css等文件），均使用utf-8編碼1.程序的版式1.1.空格空行通過將邏輯相關(guān)的代碼放到一起來增加可讀性?？崭駪?yīng)該用于如下情況:1.關(guān)鍵字后面跟“(”(左圓括號(hào))時(shí)應(yīng)該用一個(gè)空格隔開。代碼while?(true)?{??2.方法名和方法的“(”(左圓括號(hào))之間不要有空格。這利于區(qū)分關(guān)鍵字和方

5、法調(diào)用。3.所有的二元操作符，除了“.”(圓點(diǎn))、“(”(左圓括號(hào))和“[”(左中括號(hào))，都應(yīng)該使用一個(gè)空格來和操作數(shù)隔開。4.一元操作符和操作數(shù)之間不應(yīng)該使用空格隔開，除了操作符是一個(gè)單詞時(shí)，如typeof。5.for語(yǔ)句控制部分的每個(gè)“;”(分號(hào))應(yīng)該在后面跟一個(gè)空格。6.每個(gè)“,”(逗號(hào))后面應(yīng)該跟一個(gè)空格。1.2.縮進(jìn)縮進(jìn)的最小單位是4個(gè)空格,4個(gè)空格為一個(gè)縮進(jìn)單位。不要使用tab鍵,一個(gè)函數(shù)的開始頂格寫,進(jìn)入函數(shù)體之后縮進(jìn)一個(gè)單位,進(jìn)入下一層再縮進(jìn)一個(gè)單位,以此類推,例子如下:FunctiongetA

6、ttr(){For(varI=0;I

7、串之后對(duì)該標(biāo)簽進(jìn)行計(jì)息參數(shù)str表示…*/(2)對(duì)于新定義變量的用途以及關(guān)鍵的語(yǔ)句必須進(jìn)行單行注釋，注釋添加的位置可以在上一行，也可以在行末，視情況而定，如果一個(gè)語(yǔ)句較長(zhǎng)，推薦在上一行進(jìn)行注釋；如果語(yǔ)句較短可以在行末進(jìn)行注釋。（3）對(duì)于一個(gè)函數(shù)的結(jié)尾，應(yīng)該在結(jié)尾處加上此函數(shù)結(jié)束的標(biāo)志用于表示函數(shù)的結(jié)束，例如：//endoffunctiongetAtrr（4）對(duì)于有多層嵌套，應(yīng)該在最外層以及具有關(guān)鍵意義的層的結(jié)尾處添加結(jié)束注釋，例如：For(varI=…){Varj=0;…14If(…){For(vart…){…

8、}}//endofif}//endoffor更新注釋非常重要,修改后的代碼應(yīng)該及時(shí)的更新注釋，函數(shù)功能轉(zhuǎn)變了應(yīng)該及時(shí)的更新函數(shù)頭的注釋。（5）讓注釋有意義。更多的關(guān)注于不能馬上可見的東西。不要用如下內(nèi)容浪費(fèi)讀者的時(shí)間:代碼i?=?0;?//?Set?i?to?zero.??一般使用行注釋。把塊注釋用于正式文檔或外部注釋。1.1.變量聲明（1）所有的變量應(yīng)該在使用前聲明，并添加用途注釋。