❧ 代码书写规范

命名规范

• 项目目录和文件 命名全部采用 小写 方式，以 中划线 分隔，有复数结构时，要采用 复数 命名法，例如：ant-design-pro、scripts

• 文件名带 版本号 时，需要用字母 v 做为前缀，小版本号用点号 (.) 隔开，例如：detail-v2.2.js

• 变量 采用小驼峰式命名法，前缀应当是 名词

• 常量 使用 大写字母 和 下划线 来组合命名

• 函数 采用小驼峰式命名法，前缀应当是 动词，下表为常见动词约定

动词	含义	返回值
can	判断是否可执行某个动作	函数返回一个布尔值。true：可执行；false：不可执行
has	判断是否含义某个值	函数返回一个布尔值。true：含有此值；false：不含有此值
is	判断是否为某个值	函数返回一个布尔值。true：为某个值；false：不为某个值
get	获取某个值	函数返回一个非布尔值
set	设置某个值	无返回值、返回是否设置成功或者返回链式对象
load	加载某些数据	无返回值或者返回是否加载完成的结果
handle	事件处理	无返回值或者返回处理完成的结果

• 类 采用 大驼峰 式命名法，首字母大写

• 类的成员

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

匈牙利命名法（变量名＝数据类型+对象描述）

• s：表示字符串String

• i：表示整型Int(它是Number中的整数类型)

• fl：表示浮点Float(它是Number中的小数类型)

• b：表示布尔Boolean

• a：表示数组Array

• o：表示对象Object

• fn：不示函数Function

• re：表示正则Regular Expression

var aPerson = []; // Array数组
var oBtn = document.getElementById('btn'); //Object对象
var fnName = function () {}; // function函数
var sName = "w3cplus"; // string字符串

注释规范

• 函数(方法)注释

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

常用注释关键字:

注释名	语法	含义	示例
@param	@param 参数名 {参数类型} 描述信息	描述参数的信息	@param name {String} 名称
@returns	@return {返回类型} 描述信息	描述返回值的信息	@return {Boolean} true:可执行;false:不可执行
@author	@author 作者信息 [附属信息：如邮箱、日期]	描述此函数作者的信息	@author 张三 2015/07/21
@version	@version XX.XX.XX	描述此函数的版本号	@version 1.0.3
@example	@example 示例代码	演示函数的使用	@example setTitle(‘测试’)