sublime text 3 插件 DocBlockr 与 JavaScript 注释规范

发布于 2021-11-29 12:35:05 字数 2774 浏览 1219 评论 0

1、引子

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

/**
 * 这里的注释内容【会】被压缩工具压缩
 */

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

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

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

/**
 * @author ydr.me
 * @version 1.0
 */

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

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

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

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

2、插件

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

A、先写完你的函数

function testFunction(a, b, c) {

}

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

/**

C、然后回车,自动生成

/**
 * [testFunction description]
 * @param  {[type]} a [description]
 * @param  {[type]} b [description]
 * @param  {[type]} c [description]
 * @return {[type]}   [description]
 */
function testFunction(a, b, c) {

}

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

img.png

3、参考资料

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据

关于作者

浅沫记忆

暂无简介

0 文章
0 评论
763 人气
更多

推荐作者

漫雪独思

文章 0 评论 0

垂暮老矣

文章 0 评论 0

鹊巢

文章 0 评论 0

萌酱

文章 0 评论 0

雨说

文章 0 评论 0

冰葑

文章 0 评论 0

    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文