注释在代码编写过程中的重要性,写代码超过半年的就能深深的体会到。
代码注释规范是刚进入前端开发的小菜鸟们的必修课程。
要养成良好的注释习惯。
普通注释:
- 普通注释是为了帮助开发者和阅读者更好地理解程序,不会出现在API文档中。其中,单行注释以“//”开头;多行注释以“/”开头,以“/”结束。普通注释的使用需遵循以下规定。
// this is comment
- 总是在多行注释的结束符前留一个空格(使星号对齐)。例如:
/*
*/
- 不要把注释写在多行注释的开始符、结束符所在行。例如:
/*
start
end
*/
/*
here
is line 1
here
is line 2
*/
- 不要编写无意义的注释。例如:
// 初始化value变量为0
var value
= 0;
- 如果某段代码有功能未实现,或者有待完善,必须添加“TODO”标记,“TODO”前后应留一个空格。例如:
// TODO 未处理IE6-8的兼容性
function setOpacity(node,
val) {
node.style.opacity
= val;
}
文档注释:
文档注释将会以预定格式出现在API文档中。它以“/**”开头,以“/”结束,其间的每一行均以“”开头(均与开始符的第一个“”对齐),且注释内容与“”间留一个空格。例如:
/**
*
comment
*/
在webstorm中 /** + 回车 自动补齐注释
文档注释必须包含一个或多个注释标签。
- @module。声明模块,用法:
/**
*
模块说明
*
@module 模块名
*/
例如:
/**
*
Core模块提供最基础、最核心的接口
*
@module Core
*/
- @class。声明类,用法:
/**
*
类说明
*
@class 类名
*
@constructor
*/
- @class必须搭配@constructor或@static使用,分别标记非静态类与静态类。
/**
*
节点集合类
*
@class NodeList
*
@constructor
*
@param {ArrayLike<Element>} nodes 初始化节点
*/
- @method。声明函数或类方法,用法:
/**
*
方法说明
*
@method 方法名
*
@for 所属类名
*
@param {参数类型} 参数名 参数说明
*
@return {返回值类型} 返回值说明
*/
- 没有指定@for时,表示此函数为全局或模块顶层函数。当函数为静态函数时,必须添加@static;当函数有参数时,必须使用@param;当函数有返回值时,必须使用@return。
/**
*
返回当前集合中指定位置的元素
*
@method
*
@for NodeList
*
@param {Number} [i=0] 位置下标。如果为负数,则从集合的最后一个元素开始倒数
*
@return {Element} 指定元素
*/
- @param。声明函数参数,必须与@method搭配使用。
- 当参数出现以下情况时,使用对应的格式:
[参数名1,参数名2]
参数有默认值:
[参数名1=默认值,参数名2=默认值]
- @property。声明类属性,用法:
/**
*
属性说明
*
@property {属性类型} 属性名
*/
关键词 描述
@auhor 作者
@param 参数
@example 示例
@link 链接
@namespace 命名空间
@requires 依赖模块
@return 返回值
@version 版本号