js命名規范
駝峰命名法:
- Pascal Case 大駝峰式命名法:首字母大寫。eg:StudentInfo、UserInfo、ProductInfo
- Camel Case 小駝峰式命名法:首字母小寫。eg:studentInfo、userInfo、productInfo
1.項目命名
全部采用小寫方式, 以下划線分隔。
示例:my_project_name
2.目錄命名
參照項目命名規則;有復數結構時,要采用復數命名法。
示例:scripts, styles, images, data_models
3.JS文件命名
1.變量:必須采用小駝峰式命名法。
命名規范:前綴應當是名詞。(函數的名字前綴為動詞,以此區分變量和函數)
命名建議:盡量在變量名字中體現所屬類型,如:length、count等表示數字類型;而包含name、title表示為字符串類型。
2.常量:必須采用全大寫的命名,且單詞以_分割,常量通常用於ajax請求url,和一些不會改變的數據
命名規范:使用大些字母和下划線來組合命名,下划線用以分割單詞
3.函數:小駝峰式命名法
命名規范:前綴應當為動詞
命名建議:可使用常見動詞約定
栗子:
4.類 & 構造函數
命名方法:大駝峰式命名法,首字母大寫。
命名規范:前綴為名稱。
5.類的成員
公共屬性和方法:跟變量和函數的命名一樣
私有屬性和方法:前綴為_(下划線),后面跟公共屬性和方法一樣的命名方式
6.注釋規范
說明:行內注釋兩個斜桿開始,行尾結束
語法:code //這個是行內注釋
使用方式://與代碼之間一個空格 與 注釋文字之間一個空格
命名建議:
// 用來顯示一個解釋的評論
// -> 用來顯示表達式的結果
// > 用來顯示console的輸出結果
多行注釋:/**/
函數(方法)注釋:
說明:函數(方法)注釋也是多行注釋的一種,但是包含了特殊的注釋要求,參照JSDoc
1.不要保存this的引用,使用Function#bind
2.給函數命名,這在做堆棧軌跡時很有幫助。
3.如果你的文件到處一個類,你的文件名應該和類名完全相同。
4.模塊
模塊應該以 ! 開始。這樣確保了當一個不好的模塊忘記包含最后的分號時,在合並代碼到生產環境后不會產生錯誤。詳細說明
文件應該以駝峰式命名,並放在同名的文件夾里,且與導出的名字一致
增加一個名為 noConflict() 的方法來設置導出的模塊為前一個版本並返回它。
永遠在模塊頂部聲明 'use strict';。
5.構造函數
給對象原型分配方法,而不是使用一個新對象覆蓋原型。覆蓋原型將導致繼承出現問題:重設原型將覆蓋原有原型!
方法可以返回 this 來實現方法鏈式使用。
摘自:https://www.cnblogs.com/Hsong/p/9016950.html