sublime注释插件DocBlockr

Posted 2020-08-25 WWSASUKE

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/