VSCode中自动生成文档头注释和函数注释-Toy模板网

这篇具有很好参考价值的文章主要介绍了VSCode中自动生成文档头注释和函数注释。希望对大家有所帮助。如果存在错误或未考虑完全的地方，请大家不吝赐教，您也可以点击"举报违法"按钮提交疑问。

在编写python代码的时候，有时候需要对函数的作用、参数以及返回值进行说明，如下图所示，自己编写的话会有很多重复操作，于是希望可以使用快捷键自己生成，下面进行具体步骤的讲解。
vscode自动生成注释,vscode,编辑器,python

1.下载koroFileHeader插件

打开VSCode，在扩展中搜索koroFileHeader，进行安装
vscode自动生成注释,vscode,编辑器,python

2.进行格式相关自定义设置

1.在VSCode中打开设置
vscode自动生成注释,vscode,编辑器,python

vscode自动生成注释,vscode,编辑器,python
2.在设置中添加如下内容

"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": { // 快速注释函数
        "description": "", // 函数描述
        "Author": "lyq", // 作者
        "Date": "Do not edit", // 创建时间
        "param ": "", // 函数参数
        "return": "", // 函数输出
 
        // "LastEditTime": "Do not edit", // 最后一次修改的时间
        // "LastEditors": "lyq" // 修改人员
    },
    "fileheader.customMade": { // 快速注释文件头部
        "Description": "", // 文件描述
        "Author": "lyq", // 作者
        "Date": "Do not edit", // 创建时间
        "LastEditTime": "Do not edit", // 最后一次修改的时间
        "LastEditors": "lyq" // 修改人员
    }