下载koroFileHeader插件
然后点它的wiki文档
会跳到它的github
配置字段 · OBKoro1/koro1FileHeader Wiki · GitHub
先找到vscdoe的setting文件,两种方法:
1,
然后点这里:
或者去搜索框搜索:FileHeader
出现如下:
然后,这三个,随便点一个:在settings.json中编辑
一般是在settings.json文件配置如下几个字段,主要参考上面的github:
"fileheader.configObj": { //快速添加文件头部注释和函数注释
"createFileTime": true, // 设置为true则为文件新建时候作为date,否则注释生成时间为date
"autoAdd": true, // 自动生成注释
"language": {
"py": {
"head": "'''",
"middle": "@",
"end": "'''"
},
"h/hpp/cpp": {
"head": "/*** ", // 统一增加几个*号
"middle": " * @",
"end": " */"
}
},
"annotationStr": {
"head": "/*",
"middle": " * @",
"end": " */",
"use": true // 设置自定义注释可用
},
},
"fileheader.cursorMode": { // 快速注释函数 ctrl+alt+t
"description": "", // 函数描述
"Author": "wujiacheng", // 作者
"Date": "Do not edit", // 创建时间
"param ": "", // 函数参数
"return": "", // 函数输出
// "LastEditTime": "Do not edit", // 最后一次修改的时间
// "LastEditors": "wujiacheng" // 修改人员
},
"fileheader.customMade": { // 快速注释文件头部 ctrl+alt+i
"Description": "", // 文件描述
"Author": "wujiacheng", // 作者
"Date": "Do not edit", // 创建时间
"LastEditTime": "Do not edit", // 最后一次修改的时间
"LastEditors": "wujiacheng" // 修改人员
}
其中fileheader.cursorMode 是函数注释: 快捷键是 ctrl+win+t, 需要在函数的上面一行,按快捷键
fileheader.customMade是文件头部注释: 快捷键是 ctrl+win+i
fileheader.configObj 是额外的配置, 比如让头文件头部注释,增加一些符号,例如py文件的:
"py": {
"head": "'''",
"middle": "@",
"end": "'''"
},
表示文件头部注释在第一行头部head增加'''
在尾部end增加'''
在中间增加@
最后效果如下:
'''
@Description:
@Author: wujiacheng
@Date: 2022-12-23 19:14:24
@LastEditTime: 2022-12-23 19:41:33
@LastEditors: wujiacheng
'''
函数注释效果如下:
'''
@description:
@return {*}
@Author: wujiacheng
@Date: 2022-12-24 01:25:30
@param {*} self
@param {List} nums
'''
def maxSubArray2(self, nums: List[int]) -> int:
n = len(nums)
if n == 0:
return 0
if n == 1:
return nums[0]