一、安装方法
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) {};