JS规范

JS规范

1. 减少声明全局变量，如果要声明，请明确挂载到全局对象上，示例：window.xxx
2. 变量先声明，后使用

命名规范

变量

采用小驼峰命名法，示例：studentName

常量

全部大写，单词之间使用下划线连接，示例：MAX_AGE

函数

前缀为动词

动词	含义	返回值	示例
动词	含义	返回值	示例
get	设置某个值	函数返回一个非布尔值	getName getStudentList
set	获取某个值	无返回值、返回是否设置成功或者返回链式对象	setName
has	判断是否含有某个值	函数返回一个布尔值
is	判断是否为某个值	函数返回一个布尔值
can	判断是否可执行某个动作	函数返回一个布尔值	canClickButton
load	加载某个数据	无返回值或者返回是否加载完成的结果	loadMapData

注释规范

行注释

单独一行采用双斜线注释 双斜线与文字之间间隔一个空格，示例

//  获取学生人数

块注释

采用/* */ 注释

函数注释

采用函数标准注释，写清楚函数作用 参数 参数类型 参数说明 返回值 返回值类型 返回值说明

行内注释

紧跟代码后面采用双斜线注释 与代码之间间隔一个空格，双斜线与注释内容之间间隔一个空格，示例：

var userName="zhangsan" // 用户姓名

 

PS：注释推荐采用 vscode内置注释功能