DocBlockr插件不仅仅可以自动生成注释，还可以手动编辑注释的格式。
一、安装 DocBlockr
1. 打开Sublime，按下Ctrl+Shift+p进入 Command Palette；
2. 输入install进入 Package Control: Install Package；
3. 输入SublimeLinter，选择DocBlockr进行安装。
二、配置示例
默认的补全代码却没有作者，时间等信息，需要自己配置。打开Preferences -> Package Settings -> DocBlockr->Settings - User，将下面的配置粘贴进去：
|
1 2 3 4 5 6 7 8 |
{ "jsdocs_extra_tags": [ "@Author yourname", "@Date {{date}}", "@DateTime {{datetime}}", "@Domian http://mounui.com" ] } |
简单使用：在写完的函数上面一行输入\**然后按Tab或者Enter效果如下
三、注释规范
目前脚本、样式的注释格式都有一个已经成文的约定规范（这些约定规范最初是YUI Compressor制定的，详见参考资料）了，如下：
|
1 2 3 4 5 6 7 |
/** * 这里的注释内容【会】被压缩工具压缩 */ /*！ * 这里的注释内容【不会】被压缩工具压缩 * 与上面一个注释块不同的是，第2个*换成了! */ |
其中说到这里说到的压缩工具有YUI Compressor 、Google Closure Compiler、gulp-uglify、grunt-contrib-uglify等，这些压缩工具都支持以上的压缩约定。常常把文件的关键信息放在第2种注释内容里，如文件名称、版本号、作者等。
关于这些关键信息，都有一些关键词和一定的格式来书写。关键词书写格式为：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
/** * @author ydr.me * @version 1.0 */ 使用@key desc格式来书写，常用的关键词有： @author 作者 @param 参数 @example 例子 @link 链接 @namespace 命名空间 @requires 依赖 @return 返回值 @version 版本号 其中，param关键词的格式为： /** * @param {String} 参数描述 */ |
我的微信
扫一扫加我微信
