sublime text3 注释

Sublime注释插件-Doc?Blockr

注释规范

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

 

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

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

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

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

sublime text3 注释

原文地址:http://www.cnblogs.com/teng-xia/p/5347747.html

为您推荐

发表评论

电子邮件地址不会被公开。 必填项已用*标注