sublime text 头部自动化注释(DocBlockr)

  1. 通过sublime text下package control 的 Install Package安装DocBlockr插件。
  2. 打开Preferences -> Package Settings -> DocBlockr->Settings - User 配置文件,也可以直接将新修改的配置信息保存到”Default Settins”。(“Default Settins”是默认配置文件,需要管理员权限才能修改。一般情况下不推荐直接修改系统默认配置文件)。
    DocBlockr
  1. 将下面的代码根据需求保存到User配置文件中并保存文件,再次触发DocBlockr即可看到效果。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"jsdocs_param_name": false,
"jsdocs_param_description": false,
"jsdocs_return_description": [],
"jsdocs_return_tag": false,
"jsdocs_extra_tags_go_after": [],
"jsdocs_align_tags": [],
"jsdocs_extra_tags": [
"",
"@DateTime {{datetime}}",
"",
"@author ***",
"",
"保持优雅的代码注释",
"maintain the elegant code comments",
"@version ${1:[version]}",
]
}

DocBlockr
DocBlockr
更多自定义配置可参考官方文档(https://github.com/spadgos/sublime-jsdocs)。