vs code中自动生成文件头注释信息，函数等

骚饼

已于 2023-12-06 11:31:42 修改

阅读量950

点赞数 3

分类专栏：工具 vue react 文章标签： vscode 前端代码规范

于 2023-05-06 16:42:15 首次发布

本文链接：https://blog.csdn.net/qq_36798133/article/details/130530759

版权

vue 同时被 3 个专栏收录

11 篇文章 0 订阅

订阅专栏

react

6 篇文章 1 订阅

订阅专栏

工具

3 篇文章 0 订阅

订阅专栏

前言

文件头自动生成注释内容(新建文件后自动生成)

koroFileHeader (自行插件商店安装)

将下方的设置内容增加至vs的设置中(seetings.json中)

配置

通过strl+shift+p 打开快捷搜索 - 输入setting.json打开后，将如下的配置数据复制于该文件内保存

如果有需要其他拓展项，可自行补充，目前这些内容其实已经满足常规使用需求

"fileheader.cursorMode": {
        "description": "",
        "param ": "",
        "return": ""
    },
    "fileheader.customMade": {
        "Description":"" ,//文件内容描述
		"Author":"Renmr",//编辑人
		"Date": "Do not edit",//时间
        "FilePath": "", // 设置后，默认生成文件相对于项目的路径
		// "LastEditTime": "Do not edit",
		// "LastEditors": "Su Yunzheng",
    },
    "fileheader.configObj": {
        "createFileTime": true, //设置为true则为文件新建时候作为date，否则注释生成时间为date
        "autoAdd": true, //自动生成注释
        "annotationStr": {
            "head": "/*",
            "middle": " * @",
            "end": " */",
            "use": true //设置自定义注释可用
        },
    },