在工作中常常会遇到这样的问题:
项目经历了多次迭代,开发历史悠久,在你修改某个模块或者某个组件时不能确定当初是谁开发的?用来做什么的?最后一次修改是在什么时候?
亦或者自己的文件被别人修改了,但不知道是谁修改的。
为了解决以上问题我找了一个插件,用来生成文件的头部注释,可以快速简单的了解到,文件的创建者,创建时间,最后一次编辑者和编辑时间,以及文件的描述,需要项目所有成员都统一安装插件,并配置好,这样在每次修改了文件保存的时候就会自动生成注释(自己装了插件只有自己编辑才会自动生成,所以需要项目所有成员都安装)。
实例:
👇下面图片为项目实例,可以看到创建人是mao**,创建时间在02-20,最后一次编辑人是mao**,编辑时间在04-17,此文件是用来做错误文案的,这样就能清楚的知道文件的用途,以及最近编辑的情况。
是不是很方便? 小伙伴们还不快用起来
👇下面是自动生成的函数的注释,一般用于公共函数,他可以清楚的告诉其他小伙伴这个函数的作用,需要传什么参数,以及它的返回值。
👇好处都知道了,那么下面我们就开始安装插件把
第一步:安装插件
vscode搜索KoroFileHeader ,并安装
第二步:配置插件
在vscode的配置文件setting.json中配置
头部注释的创建/编辑时间不需要修改, 会自动生成时间
"fileheader.customMade": { // 此为文件头部注释
"Author":"your Name", // 创建人 写上自己的名字
"Date":"Do not edit", // 创建时间
"LastEditors":"your Name", // 最后一次编辑人 写上自己的名字
"LastEditTime":"Do not edit", // 最后一次编辑时间
"Description":"" // 文件描述 生成注释后在手动编辑
},
"fileheader.cursorMode": { //此为函数注释
"description":"", // 函数功能描述 生成注释后在手动编辑
"param": "", // 参数 生成注释后在手动编辑
"return": "", // 返回值 生成注释后在手动编辑
"author":"your Name" // 创建人 写上自己的名字
}
第三部:使用插件
快捷键:
文件头部注释: 在当前编辑文件中使用快捷键即可生成文件头部注释。
window系统:ctrl+alt+i
mac系统:ctrl+cmd+i
函数注释: 将光标放在函数行或者将光标放在函数上方的空白行 使用快捷键即可生成函数注释。
window系统:ctrl+alt+t
mac系统:ctrl+cmd+t
函数注释的快捷键失效的小伙伴可以看看作者提供的信息收集贴找找解决方案。github.com/OBKoro1/kor…