看完这篇博客，你将了解

  • 函数注释规范
  • 模块注释规范
  • 两个常用注释( TODO, FIXME)
  • 文件/资源命名规范

函数注释

/* 方法说明
 * @method 方法名
 * @for 所属类名
 * @param{参数类型}参数名 参数说明
 * @return {返回值类型} 返回值说明
*/

比如

/*函数说明
 * @param {string} p1 参数1的说明
 * @param {string} p2 参数2的说明，比较长
 *     那就换行了.
 * @param {number=} p3 参数3的说明（可选）
 * @return {Object} 返回值描述
 */
 function foo(p1, p2, p3) {
  var p3 = p3 || 10;
  return {
    p1: p1,
    p2: p2,
    p3: p3
  };
}

模块注释

/* 模块说明
* @module 模块名
*/

待办内容与待处理 bug 的注释

// TODO: 标注待实现的功能。
// FIXME: 标注出现的问题。

文件/资源命名规范

记住两点：

  1. 都用小写
  2. 下划线，驼峰式分隔改为中划线

比如：

antScript.js
ant_reg.html

都不推荐：

  1. 第一行的问题在于，文件名称有大写字符，改为小写
  2. 第二行的问题在于使用下划线为分隔符，改为中划线

修改：

ant-script.js
ant-reg.html