sublime插件DocBlockr注释

DocBlockr插件不仅仅可以自动生成注释,还可以手动编辑注释的格式。

一、安装 DocBlockr

1. 打开Sublime,按下Ctrl+Shift+p进入 Command Palette;

2. 输入install进入 Package Control: Install Package;

3. 输入SublimeLinter,选择DocBlockr进行安装。

二、配置示例

默认的补全代码却没有作者,时间等信息,需要自己配置。打开Preferences -> Package Settings -> DocBlockr->Settings - User,将下面的配置粘贴进去:

简单使用:在写完的函数上面一行输入\**然后按Tab或者Enter效果如下

sublime插件DocBlockr注释

三、注释规范

目前脚本、样式的注释格式都有一个已经成文的约定规范(这些约定规范最初是YUI Compressor制定的,详见参考资料)了,如下:

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

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

 

weinxin
我的微信
扫一扫加我微信
琪玥

发表评论

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen: