sublime3 docblocker插件定制自己的注释，配置步骤

最新推荐文章于 2021-08-29 15:05:42 发布

原创最新推荐文章于 2021-08-29 15:05:42 发布 · 3.1w 阅读

11 ·

本内容遵循CC 4.0 BY-SA版权协议

收录于

ide

本文介绍了一款Sublime Text插件DocBlockr的功能与使用方法。该插件能自动生成和编辑代码注释，提高开发效率。文章详细讲解了如何安装配置DocBlockr，并提供了自定义注释样式的示例。

DocBlockr很好用，不仅仅可以自动生成注释，还可以手动编辑注释的格式。

安装方法：
Cmd+Shift+P -> Install Package -> docblockr

windows是ctrl+shift+P

自定义配置：
Preference -> Package Settings -> DocBlockr -> Settings - User

配置成如下内容：

  {
    "jsdocs_extra_tags":[
        "@Author Hybrid",
        "@DateTime {{date}}",
        "@copyright ${1:[copyright]}",
        "@license ${1:[license]}",
        "@version ${1:[version]}"
    ],
    "jsdocs_function_description": false
  }

效果图如下：

用过一段时间后想要编写自己的注释内容，如去掉copyright，version等注释，添加一些自己想要添加的注释,查找了很多注释格式，发现还是这种的精简：

/**
* 函数功能简述
*
* 具体描述一些细节
*
* @param {string} address 地址
* @param {array} com 商品数组
* @param {string} pay_status 支付方式
* @returns void
* @date 2016-06-12
* @author Judy

所以仔细看了下参考的链接，总结如下

参考： https://github.com/spadgos/sublime-jsdocs/

部分内容转载至：http://fy98.com/2016/02/05/docblocker-usage/