Sublime Text3 插件:DocBlockr与javascript注释规范

  • A+
所属分类:开发者工具

1、引子

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

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

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

使用 @key desc 格式来书写,常用的关键词有:

关键词描述
@author作者
@param参数
@example例子
@link链接
@namespace命名空间
@requires依赖
@return返回值
@version版本号

其中,param关键词的格式为:

2、插件

使用package control安装DocBlockr。安装完成后使用方法如下:

A、先写完你的函数

B、然后在函数的前面一行,输入

C、然后回车或者按 Tab ,自动生成

D、并且在注释块中,按@键可以展开关键词:

Sublime Text3 插件:DocBlockr与javascript注释规范

3、参考资料

weinxin
我的微信公众号
我的微信公众号扫一扫

发表评论

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