JavaScript注释规范

一、引子

在写代码的时候，尤为是写脚本，最须要注释了。目前脚本、样式的注释格式都有一个已经成文的约定规范（这些约定规范最初是YUI Compressor制定的，详见参考资料）了，以下：

/**
 * 这里的注释内容【会】被压缩工具压缩
 */

/*！
 * 这里的注释内容【不会】被压缩工具压缩
 * 与上面一个注释块不一样的是，第2个*换成了!
 */

其中说到这里说到的压缩工具备YUI Compressor 、Google Closure Compiler、gulp-uglify、grunt-contrib-uglify等，这些压缩工具都支持以上的压缩约定。经常把文件的关键信息放在第2种注释内容里，如文件名称、版本号、做者等。

关于这些关键信息，都有一些关键词和必定的格式来书写。关键词书写格式为：

/**
 * @author ydr.me
 * @version 1.0
 */

使用@key desc格式来书写，经常使用的关键词有：

关键词	描述
@auhor	做者
@param	参数
@example	示例
@link	连接
@namespace	命名空间
@requires	依赖模块
@return	返回值
@version	版本号

其中，param关键词的格式为：

/**
 * @param {String} 参数描述
 */

二、插件

使用package control安装DocBlockr。安装完成后使用方法以下：

A、先写完你的函数

function testFunction(a, b, c) {

}

B、而后在函数的前面一行，输入

/**

C、而后回车，自动生成

/**
 * [testFunction description]
 * @param  {[type]} a [description]
 * @param  {[type]} b [description]
 * @param  {[type]} c [description]
 * @return {[type]}   [description]
 */
function testFunction(a, b, c) {

}

D、而且在注释块中，按@键能够展开关键词：

三、参考资料

• YUI Compressor注释规范：http://yui.github.io/yuidoc/syntax/
• JSDOC：http://usejsdoc.org/