sublime注释插件DocBlockr

最新推荐文章于 2025-01-10 10:03:36 发布

转载最新推荐文章于 2025-01-10 10:03:36 发布 · 250 阅读

0 ·

CC 4.0 BY-SA版权

原文链接：http://www.cnblogs.com/weizaiyes/p/6222507.html

文章标签：

#java

本文介绍如何使用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/

转载于:https://www.cnblogs.com/weizaiyes/p/6222507.html