头部注释是对程序和函数的文档注释说明,用于标注程序的基本信息,函数的功能和参数说明等,完善的头部文档标注更利于程序阅读。
一、安装KoroFileHeader扩展
二、配置注释信息
搜索fileheader设置,文件头部注释:Fileheader:custom Made,函数注释:Fileheader:cursor Mode。
{
"workbench.colorTheme": "GitHub Light Default",
// 函数注释
"fileheader.customMade": {
"Description": "", // 介绍文件的作用、文件的入参、出参。
"Author": "ZhenLi", // 创建文件的作者
"Date": "Do not edit", // 文件创建时间(不变)
"LastModifiedBy": "ZhenLi", // 文件最后编辑者
// 由于编辑文件就会变更最后编辑时间,多人协作中合并的时候会导致merge
// 可以将时间颗粒度改为周、或者月,这样冲突就减少很多。搜索变更时间格式: dateFormat
"LastEditTime": "Do not edit", // 文件最后编辑时间
// 输出相对路径,类似: /文件夹名称/src/index.js
// "FilePath": "Do not edit", // 文件在项目中的相对路径 自动更新
// 插件会自动将光标移动到Description选项中 方便输入 Description字段可以在specialOptions更改
// custom_string_obkoro1~custom_string_obkoro100都可以输出自定义信息
// 可以设置多条自定义信息 设置个性签名、留下QQ、微信联系方式、输入空行等
// "custom_string_obkoro1": "",
// 版权声明 保留文件所有权利 自动替换年份
// "custom_string_obkoro1_copyright": "Copyright (c) ${now_year} by 用户/公司名, All Rights Reserved. "
},
// 函数注释
"fileheader.cursorMode": {
"description": "", // 函数注释生成之后,光标移动到这里
"param": "", // param 开启函数参数自动提取 需要将光标放在函数行或者函数上方的空白行
"return": "",
}
}
三、快捷键
默认情况下文件头部注释快捷键crtl+win+i
(window),ctrl+cmd+t
(mac),函数注释快捷键ctrl+win+t
(window), ctrl+alt+t
(mac)。但是有的电脑存在快捷键被占用,可以设置其他快捷键。文件-首选项-快捷键,搜索fileheader
,设置其他快捷键。