VSCode一键生成、自动添加注释

最新推荐文章于 2025-03-21 16:54:53 发布

一个昵称被占用的川川

最新推荐文章于 2025-03-21 16:54:53 发布

阅读量1.7w

点赞数 4

分类专栏：使用工具分享文章标签： 1024程序员节 vscode 编辑器 visual studio code

本文链接：https://blog.csdn.net/weixin_43817571/article/details/120932322

版权

本文介绍了如何在VSCode中安装并配置koroFileHeader插件，以此实现一键生成和自动添加文件及函数注释。用户可以通过设置json文件定制注释模板，并使用快捷键在Windows（Ctrl+Alt+I/Ctrl+Alt+T）或Mac（Ctrl+Cmd+I/Ctrl+Cmd+T）上快速操作。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

VSCode自动添加注释

首先在商店搜索插件：koroFileHeader，安装后重启客户端以生效
在这里插入图片描述

在设置中搜索fileheader，找到如下setting.json的配置文件，随便点开一个即可
在这里插入图片描述

以下为此插件的所有配置项，删除原有配置项，全部粘贴过去即可
代码中的提示信息已经很详细了，如果还有问题可以去商店界面查看日志
若自动添加注释，可查看代码的配置规则，在代码45行左右

{
   
    "liveServer.settings.donotShowInfoMsg": true,
    "editor.fontSize": 16,
    "security.workspace.trust.untrustedFiles": "open",
    "workbench.colorTheme": "Snazzy Light",
    "workbench.iconTheme": "vscode-icons-mac",
    "files.associations": {
   
        "*.cjson": "jsonc",
        "*.wxss": "css",
        "*.wxs": "javascript"
    },
    "emmet.includeLanguages": {
   
        "wxml": "html"
    },
    "minapp-vscode.disableAutoConfig": true,
    "liveServer.settings.ignoreFiles": [

        ".vscode/**",
        "**/*.scss",
        "**/*.sass",
        "**/*.ts"
    ],
   
    // 头部注释
"fileheader.customMade": {
   
  // 头部注释默认字段
  "Author": "YourName",
  "Date": "Do not edit", // 设置后默认设置文件生成时间
  "LastEditTime": "Do not edit",