javascript 代码规范（1）-命名规范

1.命名规范：

1. Pascal Case 大驼峰式命名法：首字母大写。eg：StudentInfo、UserInfo、ProductInfo
2. Camel Case 小驼峰式命名法：首字母小写。eg：studentInfo、userInfo、productInf

命名包含变量、常量、函数名、类名、属性名和函数或类的参数，以及包括文件及文件夹的命名，

要求：命名要语义化

1.1 常量命名

命名方式：全部大写

命名规范：使用大写字母和下划线来组合命名，下划线用以分割单词

示例：

const MAX_COUNT = 10;
const URL = 'https://www.qdtalk.com';

1.2 变量命名

命名方式：小驼峰

命名规范：前缀名词

命名建议：尽量在变量名字中体现所属类型，如:length、count等表示数字类型；而包含name、title表示为字符串类型。

示例：

// 好的命名方式
let maxCount = 10;
let tableTitle = 'LoginTable';
// 不好的命名方式
let setCount = 10;
let getTitle = 'LoginTable';

1.2 函数命名

命名方法：小驼峰式命名法。

命名规范：前缀应当为动词。

命名建议：可使用常见动词约定

示例：

// 是否可阅读
function canRead(): boolean {
  return true;
}
// 获取名称
function getName(): string {
  return this.name;
}

1.3 类，构造函数

命名方法：大驼峰式命名法，首字母大写。

命名规范：前缀为名称。

示例

// 好的命名方式
let maxCount = 10;
let tableTitle = 'LoginTable';
// 不好的命名方式
let setCount = 10;
let getTitle = 'LoginTable';

公共属性和方法：跟变量和函数的命名一样。

私有属性和方法：前缀为_(下划线)，后面跟公共属性和方法一样的命名方式。

class Person {
  private _name: string;
  constructor() { }
  // 公共方法
  getName() {
    return this._name;
  }
  // 公共方法
  setName(name) {
    this._name = name;
  }
}
const person = new Person();
person.setName('mervyn');
person.getName(); // ->mervyn

1.4文件命名：

命名规范：文件名全部使用小写字母和连词线（all-lowercase-with-dashes）

参考链接：为什么文件名要小写？

本文参考链接：

• javascript-style-guide
• js命名与注释规范详解