JavaScript命名規范

一、變量

命名方法: 小駝峰式命名法
命名規范：前綴為形容詞 （函數前綴為動詞, 以此來區分函數和變量）

# 好的命名方式
let maxCount = 10;
let tableTitle = '啦啦啦';
# 不好的命名方式
let setConut = 10;
let getTitle = '啦啦啦';

二、常量

命名方法：名詞全部大寫
命名規范：使用大寫字母和下划線來組合命名，下划線用來分割單詞。

const MAX_COUNT = 10;
const URL = '//www.huifenqi.com';

三、函數 & 方法

命名方法： 小駝峰式命名法
命名規范： 前綴應該為動詞
命名建議：常用動詞約定

動詞	含義
can	判斷是否可執行某個動作
has	判斷是否含義某個值
is	判斷是否為某個值
get	獲取某個值
set	設置某個值
load	加載某些數據

// 是否可閱讀
function canRead() {}
// 獲取名稱
function getName() {}

四、類 & 構造函數

命名方法：大寫駝峰式命名法，首字母大寫。
命名規范：前綴為名稱。

class Persion {
  constructor(name) {
   ...
  }
}

let person = new Person('啦啦啦');

五、類的成員

類的成員包括：

公共屬性和方法： 跟變量和函數命名一樣。

私有屬性和方法：前綴為下划線_, 后面跟公共屬性和方法一樣的命名方式。

class Person {
  // 私有屬性 
  _name: string;
  constructor() { }
  // 公共方法
  getName() {
    return this._name;
  }
  // 公共方法
  setName(name) {
    this._name = name;
  }
}

六、注釋規范

格式化插件推薦prettier
6.1 單行注釋

// 設置標題
setTitle()

6.2 多行注釋

/*
 * 代碼執行到這里后會調用setTitle()函數
 * setTitle()：設置title的值
 */
setTitle();

6.3 函數 & 方法注釋

/**
 * 函數說明
 * @關鍵字
 **/

常用關鍵字注釋

注釋名	語法	含義	示例
@param	@param {參數類型} 描述信息	描述參數	@param {String} name 傳入名稱
@return	@return {參數類型} 描述信息	描述返回值	@retun {Boolean} true: 可執行; false: 不可執行
@author	@author 描述信息	描述作者	@author 某某某 2018/04/24
@example	@example 示例代碼	演示函數的使用	@example setTitle('啦啦啦');

---

作者：前端小母雞
鏈接：https://www.jianshu.com/p/75591d47312a