vscode配置文件头部注释

目录

• ​​插件​​
• ​​配置​​
• ​​参考​​

插件

下载插件koroFileHeader

配置

新建settings.json文件

{
    "python.pythonPath": "D:\\ProgramData\\Anaconda3\\envs\\pt\\python.exe",
    "fileheader.Author": "Su Yunzheng",

    // 插件配置选项,readme:https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE
    //配置新建文件注释和方法注释
    "fileheader.configObj": {
        "createFileTime": true,//设置为true则为文件新建时候作为date，否则注释生成时间为date
        "autoAdd": true,//自动生成注释，老是忘记的同学可以设置
        "annotationStr": {
        "head": "/*",
        "middle": " * @",
        "end": " */",
        "use": true//设置自定义注释可用
        },
        "headInsertLine": {
        "php": 2
        }
    },

    // "fileheader.cursorMode": {
    //  "description":"",
    //  "param ":"",
    //  "return":""
    // }，

    "fileheader.customMade": {
        "Description":"" ,//文件内容描述
        "Author":"Su Yunzheng",//编辑人
        "Date": "Do not edit",//时间
        "LastEditTime": "Do not edit",
        "LastEditors": "Su Yunzheng",
    }
    

}

在代码文件内，使用Ctrl+Alt+i 插入文件描述

参考

​​vscode添加新建文件头部注释和函数注释​​