VSCode 自动补充头部注释

00 前言

今天给大家安利一个自动补齐代码/文档前置文字的插件: koro1FileHeader

01 用法

官方设置链接
该插件可以自定义配置, 总共有三个类型:

  • fileheader.customMade
  • fileheader.configObj
  • Fileheader.CursorMode

这些函数写进VSCode的setting.json文件即可, 注意使用双引号

1.1 fileheader.customMade

用来自定义函数开头, 快捷键是Ctrl + Alt + i, 格式为"AAA": "BBB",, 通过设置后就会显示出以下的样子

1
(middle)AAA: BBB

有一些自定义的如:

  • 自生成时间Date, 修改时间LastEditTime,
  • 自定义文字custom_string_obkoro1

1.2 fileheader.configObj

这个可以配合上面那个进行设置, 包括了:

  • 自定义语言注释类型language, 如’#’ 或 ‘//‘
  • 头部注释前面插入内容beforeAnnotation, 如"py": "#!/usr/bin/env python3\n# -*- coding:utf-8 -*-"

1.3 Fileheader.CursorMode

这个是函数注释, 也可在光标处插入, 我用的少, 可以自动在函数下面添加注释, 例如传参, 调用, 返回等, 这个我用的少, 自行研究吧, 快捷键是Ctrl + Alt + t

1.4 附上我自己的设置和效果

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
// 这里是fileheader的设置
"fileheader.customMade": {
"File": "",
"Project": "",
"Author": "zzy",
"mail": "elliot.bia.8989@outlook.com",
"github": "https://github.com/elliot-bia",
"Date": "Do not edit", // 文件创建时间(不要动Do not edit)
"LastEditors": "zzy", // 文件最后编辑者
"LastEditTime": "Do not edit", // 文件最后编辑时间(不要动Do not edit)
"custom_string_obkoro1": "---------------------------------", // 这个是自定义文字, 不带: 的那种
"Description": "", // 默认设置光标会自动跳转到这里
}, // 头部注释
"fileheader.configObj": {
// 这里设置不同语言的开头
"language": {
"python": {
"head": "###", // 开始第一行
"middle": "# # ", // 中间
"end": "###" // 最后一行
}
},
// 头部注释最前面插入内容
"beforeAnnotation": {
"py": "#!/usr/bin/env python3\n# -*- coding:utf-8 -*-" // py文件默认,可修改
}
},

效果如图:
python
python效果

md
md效果图

02 设置图

效果图

顺便说一句, 我的主题是One Dark Pro Vivid, 商店搜索One Dark Pro后选择vivid, 然后图标选用VSCode Great Icons, 上面的可能不太准

03 后记

写hexo博客的, 要跳过md格式, 不然hexo generate的时候会出错
最后配置如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

// 这里是fileheader的设置
"fileheader.customMade": {
"File": "",
"Project": "",
"Author": "zzy",
"mail": "elliot.bia.8989@outlook.com",
"github": "https://github.com/elliot-bia",
"Date": "Do not edit", // 文件创建时间(不要动Do not edit)
"LastEditors": "zzy", // 文件最后编辑者
"LastEditTime": "Do not edit", // 文件最后编辑时间(不要动Do not edit)
"custom_string_obkoro1": "---------------------------------", // 这个是自定义文字, 不带: 的那种
"Description": "", // 默认设置光标会自动跳转到这里
}, // 头部注释
"fileheader.configObj": {
"prohibitAutoAdd": ["md", "json"], // 禁止.json .md文件,自动添加头部注释, 注意使用双引号
// 这里设置不同语言的开头
"language": {
"python": {
"head": "###", // 开始第一行
"middle": "# # ", // 中间
"end": "###" // 最后一行
}
},
// 头部注释最前面插入内容
"beforeAnnotation": {
"py": "#!/usr/bin/env python3\n# -*- coding:utf-8 -*-" // py文件默认,可修改
}
},

// 主题设置
"workbench.colorTheme": "One Dark Pro Vivid",
"workbench.iconTheme": "vscode-great-icons"
}

-------------本文结束  感谢您的阅读-------------