注释规范

1、注释规范

目前脚本、样式的注释格式都有一个已经成文的约定规范，最初是YUI Compressor制定。

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

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

关于这些关键信息，都由一些关键词和一定的格式来书写。关键词书写格式为：
使用@key desc格式来书写，常用的关键词有：

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

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

参考资料
YUI Compressor注释规范：http://yui.github.io/yuidoc/syntax/
JSDOC：http://usejsdoc.org/
FED文章：http://frontenddev.org/article/sublime-does-text-3-plug-in-docblockr-with-javascript-comments-specification.html