javascript命名规范-IT无限

项目命名

全部采用小写方式，以下划线分隔。
示例：my_project_name

一、变量

命名方法: 小驼峰式命名法
命名规范：前缀为形容词（函数前缀为动词, 以此来区分函数和变量）

好的命名方式

let maxCount = 10;
let tableTitle = '标题';

不好的命名方式

let setConut = 10; //不要使用动词

二、常量

命名方法：名词全部大写
命名规范：使用大写字母和下划线来组合命名，下划线用来分割单词。

const MAX_COUNT = 10;
const URL = 'http://www.tooi.cn';

三、函数 & 方法

命名方法：小驼峰式命名法
命名规范：前缀应该为动词
常用动词约定

动词	含义
can	判断是否可执行某个动作
has	判断是否含义某个值
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

单行注释

// 设置标题
setTitle()

多行注释

/*
* 代码执行到这里后会调用setTitle()函数
* setTitle()：设置title的值
*/
setTitle();

6.3 函数 & 方法注释

/**
 * 函数说明
 * @关键字
 **/

参考

https://www.cnblogs.com/Hsong/p/9016950.html
https://blog.csdn.net/Jiang216/article/details/121414732

javascript命名规范