前端編碼規(guī)范

  1. 英文單詞保證拼寫正確。
  2. 盡量不使用中文拼音;
  3. 重要常量、變量、方法等保證詳細注釋,關(guān)鍵業(yè)務(wù)邏輯進行詳細記錄;
  4. 變量命名時使用有意義的英文單詞,建議使用前綴或后綴標(biāo)識變量類型,如str(字符串),num(數(shù)字),bol(boolean),obj(對象),arr(數(shù)組);
    臨時變量可以簡寫,比如:str,num,bol,obj,fun,arr等。
  5. 勿使用1、2、3,a、b、c等無意義命名,循環(huán)變量可以簡寫,比如:i,j,k等;
  6. 相同含義的變量命名風(fēng)格保持統(tǒng)一,如arrayList/array-list;
  7. 命名盡量區(qū)分單復(fù)數(shù),清楚表達含義,可以使用list或加s標(biāo)識復(fù)數(shù),根據(jù)數(shù)據(jù)類型命名;
  8. 私有變量,推薦使用”_”開頭,小駝峰命名,如var _this = this;
  9. Html、css文件命名小駝峰命名,如login.html;
  10. Js文件命名大駝峰式命名,如DataFactory.js;
  11. 常量,大寫字母,下劃線“_”分隔;
  12. Css 樣式命名,按頁面元素分級命名,可使用“-”分隔,盡量表達清楚含義;
  13. 方法命名時常用動詞:can/has/is(狀態(tài))、get(獲取值),set(設(shè)置值),handle(處理操作)、add(添加)、delete/remove(刪除/移除)、edit、query/search、load、reload、refresh、create/destroy、start/stop, insert、begin/end等。
    常用介詞:before、after、in、on、over等
  14. 方法可以使用@param @return進行參數(shù)和返回值的注釋;
  15. 文件夾和文件使用小寫字母,增加可移植性和易讀性;
  16. 盡量不在window下定義全局變量;
  17. 注意對象或數(shù)組最后元素后不能多逗號,chrome下沒問題,IE下會報錯;
  18. 多行塊代碼盡量使用{};
  19. 使用FIXME 或 TODO 記錄待完成問題。
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • 文/劉洪 我只想,與你的身體交流,而不談你的思想 我只想抱住你,讓黑夜產(chǎn)生暖意 我們都在衣服里藏了太久, 一絲不掛...
    風(fēng)多響易沉閱讀 368評論 0 1
  • 序言 首先看下我們要實現(xiàn)的效果是怎么樣的。通過下面的圖片,可以看到,左邊就是書籍目錄的導(dǎo)航欄,導(dǎo)航欄的上面還有全局...
    chenHanMao閱讀 1,400評論 1 8
  • 12月1日晚:燈紅酒綠的晚宴(綠洲酒店)可能會有令你驚喜的嘉賓。請參加1號晚宴的伙伴接龍: 1、 2、唐慆 3、陳...
    嘉怡寶貝閱讀 197評論 0 0

友情鏈接更多精彩內(nèi)容