我们在新建一个文件后,常常需要在文件头部加入默认注释,vscode中提供了一个koroFileHeader 的插件,可以帮助我们实现。
1.在vscode extensions中搜索并按照koroFileHeader 插件
installl完成后,重启vscode
2.打开vscode的设置(左下角管理-》设置),搜索FileHeader
搜索到内容后,点击三个中的任意一个“在setting.json中编辑”,编辑setting.json文件,加入以下内容:
{
//自动生成注解
"fileheader.configObj": {
"createFileTime": true,//设置为true则为文件新建时候作为date,否则注释生成时间为date
"autoAdd": true,//自动生成注释
"annotationStr": {
"head": "/*",
"middle": " * @",
"end": " */",
"use": true//设置自定义注释可用
},
"headInsertLine": {
"php": 2
}
},
//类注释
"fileheader.customMade": {
"Descripttion":"",
"Author":"yang fu ren",
"version":"",
"Date":"Do not edit",
"LastEditors":"yang fu ren",
"LastEditTime":"Do not Edit"
},
//方法注释
"fileheader.cursorMode": {
"descripttion":"",
"param":"",
"return":""
},
"editor.suggestSelection": "first",
"vsintellicode.modify.editor.suggestSelection": "automaticallyOverrodeDefaultValue"
}
重启vscode,这样在你创建类后会自动加上注解头。你也可以使用快捷方式加入。
类注释: window:ctrl+alt+i;mac:ctrl+cmd+i
方法注释:window:ctrl+alt+t;mac:ctrl+cmd+t