前端規(guī)范-腳本模塊

《前端規(guī)范-腳本模塊》由會(huì)員上傳分享，免費(fèi)在線(xiàn)閱讀，更多相關(guān)內(nèi)容在教育資源-天天文庫(kù)。

1、JavaScript模塊分類(lèi)全局采用面向?qū)ο蟮乃枷?，將公共的方法，集成到一個(gè)文件中。比如，基礎(chǔ)組件，項(xiàng)目組件。頁(yè)面整合頁(yè)面功能模塊，合并在一起。書(shū)寫(xiě)規(guī)范位置順序通常情況下，JavaScript代碼是和HTML代碼一起使用的，可以將JavaScript代碼放置在HTML文檔的任何地方。但放置的地方，會(huì)對(duì)JavaScript代碼的正常執(zhí)行會(huì)有一定影響，具體如下所述。放置于之間將JavaScript代碼放置于HTML文檔的標(biāo)簽之間是一個(gè)通常的做法。由于HTML文檔是由瀏覽器從上到下依次載入的，將JavaScript代碼

2、放置于標(biāo)簽之間，可以確保在需要使用腳本之前，它已經(jīng)被載入了放置于之間也有部分情況將JavaScript代碼放置于之間的。由于HTML文檔是由瀏覽器從上到下依次載入，為了避免JavaScript代碼操作HTML元素時(shí)，HTML元素還未載入而報(bào)錯(cuò)（對(duì)象不存在）和阻塞加載時(shí)，我們需要將代碼放在后面來(lái)避免這個(gè)問(wèn)題。UED-前端規(guī)范-jxl總結(jié)對(duì)于沒(méi)有特殊要求或位置順序不會(huì)導(dǎo)致錯(cuò)誤的情況下，內(nèi)嵌js放在head標(biāo)簽中，外部js放在之前。命名命名對(duì)于任何一種編程語(yǔ)言都是必

3、須，命名的好壞，是否規(guī)范，可以直接直接影響代碼的可讀性。對(duì)于命名必要要具有語(yǔ)義化，嚴(yán)禁a,b之類(lèi)的。1)變量命名：駝峰式命名，在原生JavaScript變量要求純英文字母，首字母必須小寫(xiě)，如:getNum;jQuery變量要求首字母為’$’,其他與原生JavaScript規(guī)則相同，如:$length;2)函數(shù)命名：首字母小寫(xiě)駝峰式命名。如：setName();3)類(lèi)命名：首字母大寫(xiě)，駝峰式命名。如：MyCar;4)文件命名：獨(dú)立js文件命名必須要有語(yǔ)義化其他1)文件編碼統(tǒng)一為utf-8，每行代碼結(jié)束必須有分號(hào);2)盡量避免使用存在兼容性及消耗資源的方法或熟悉，比如

4、：eval();3)注重與HTML分離，減小reflow,注重性能;4)代碼結(jié)構(gòu)清晰，加適量注釋?zhuān)岣吆瘮?shù)重用率；5)自定義插件的命名同樣根據(jù)功能來(lái)命名。SuperSlide.js；6)代碼結(jié)構(gòu)清晰，高內(nèi)聚低耦合；UED-前端規(guī)范-jxl1)類(lèi)，函數(shù)，自定義插件，及業(yè)務(wù)邏輯復(fù)雜的地方，必須有詳細(xì)的注釋?zhuān)?)涉及到公共方法或使用頻率很高，必須封裝到公共js庫(kù)中，減少代碼冗余。注釋注釋的作用是提高代碼的可讀性，幫助自己和別人閱讀和理解你所編寫(xiě)的JavaScript代碼，提高工作效率，注釋的內(nèi)容不會(huì)在網(wǎng)頁(yè)中顯示。注釋可分為單行注釋與多行注釋兩種。a.單行注釋說(shuō)明：?jiǎn)涡凶?/p>

5、釋以?xún)蓚€(gè)斜線(xiàn)開(kāi)始，以行尾結(jié)束。語(yǔ)法：//這是單行注釋使用方式：①單獨(dú)一行：//(雙斜線(xiàn))與注釋文字之間保留一個(gè)空格。②在代碼后面添加注釋?zhuān)?/(雙斜線(xiàn))與代碼之間保留一個(gè)空格，并且//(雙斜線(xiàn))與注釋文字之間保留一個(gè)空格。③注釋代碼：//(雙斜線(xiàn))與代碼之間保留一個(gè)空格。示例：//定義標(biāo)記varflag=true;setAge();//設(shè)置年齡b.多行注釋說(shuō)明：以/*開(kāi)頭，*/結(jié)尾語(yǔ)法：/*注釋說(shuō)明*/使用方式：①若開(kāi)始(/*)和結(jié)束(*/)都在一行，推薦使用單行注釋。②若至少三行注釋時(shí)，第一行為/*,最后行為*/，并且注釋文字與*保留一個(gè)空格。示例：/**代碼執(zhí)

6、行到這里會(huì)調(diào)用setAge()函數(shù)*setAge():設(shè)置年齡，傳入的參數(shù)為：Number類(lèi)型*無(wú)返回值UED-前端規(guī)范-jxl**/setAge();a.函數(shù)(方法)注釋說(shuō)明：函數(shù)(方法)也是多行注釋的一種，但是包含了特殊的注釋要求，采用Javadoc方式。語(yǔ)法：/**函數(shù)說(shuō)明*@param參數(shù)名{參數(shù)類(lèi)型}描述信息*@param參數(shù)名{參數(shù)類(lèi)型}描述信息**/示例：/**求和函數(shù)*@paramnum1{Number}參與求和運(yùn)算的值*@paramnum2{Number}參與求和運(yùn)算的值*@return{Number}求和的結(jié)果**/functionsum(nu

7、m1,num2){//todo//參數(shù)合法性···returnnum1+num2;}UED-前端規(guī)范-jxl