sublime 添加注释模块

问题背景：

规范的程序需要对函数进行注释，常用的开发工具如IDEA、VS Code都对注释模板有很好的支持。本博客介绍Sublime下支持模块注释功能的设置。

一 安装

一、安装方法
1.安装docblocker插件

    mac  Cmd+Shift+P -> Install Package -> docblockr 

    win   Ctrl+Shift+P -> Install Package -> docblockr 

step 1:Install Package

进入控制台，然后输入install，选择下面的package，

点击Install Package，系统为自动安装

 左下角安装进度如下，loading ...  ...

经过上一步回车后到达第二步（可能需要等待一会儿）,会出现搜索框，搜索DocBlockr 回车进行安装

step 2:Install docblockr 

同上，继续等待一会系统安装。

2.配置

    Preference -> Package Settings -> DocBlockr -> Settings - User

    添加配置内容：

{
    "jsdocs_extra_tags":[

       "@fuction ${1:[description]}",
        "@Author your name",
        "@DateTime {{datetime}}",
        "@copyright ${1:[copyright]}",
        "@license ${1:[license]}",
        "@version ${1:[version]}"
    ],
    "jsdocs_function_description": false
  }

二、使用方法
ctr+N 打开新文件，然后写一个函数，在该函数上面的一行，输入/**，然后按Tab/Enter建，如下显示：

ps：

1、/**是紧贴主函数上面的一行，超过了便无法自动带出如下参数的注释。

2、/**的输入是在main（）{}写好的前提下，再输入/** +Tab；

3、main函数也可以用其他函数替代，如function testFunction(a, b, c) {}；

二 功能介绍 

1 配置说明

jsdocs_extra_tags表示额外的一些配置，@param、@return属于自带的配置

若想添加额外的设置，在setting-users中添加根据自己的需要配置

2 使用技巧

在注释块中，按@键可以展开关键词

参考链接：

1.原博客 sublime docblockr 插件的自动注释功能_buck198的博客-CSDN博客_docblockr sublime

2.sublime 注释模版插件DocBlockr的使用 - knyel - 博客园