vscode使用插件KoroFileHeader添加注释

FGGIT

发布于 2024-10-15 17:04:15

1130

发布于 2024-10-15 17:04:15

文章被收录于专栏：知识学习

一、简介

KoroFileHeader 是一款用于在 VSCode 中用于生成文件头部注释和函数注释的插件，支持所有主流语言，功能强大，灵活方便，文档齐全。

VSCode 安装 KoroFileHeader 好插件，就可以直接使用。
"fileheader.customMade": {} // 头部注释
"fileheader.cursorMode": {} // 函数注释 
"fileheader.configObj": {}  // 插件配置项

二、使用

关闭自动添加头部注释，需要在 VSCode setting.json 文章中添加配置：

"fileheader.configObj": {
    "autoAdd": false, // 关闭自动生成头部注释
}

文件头部添加注释：

使用方式：进入当前页面 按快捷键即可

快捷键： window：ctrl + alt + i，mac：ctrl + cmd + i

  ```
  /*
   * @Author: your name
   * @Date: 2021-03-25 15:19:05
   * @LastEditTime: 2021-04-02 13:17:06
   * @LastEditors: Please set LastEditors
   * @Description: In User Settings Edit
   * @FilePath: /laravel-test/app/Http/Controllers/UserController.php
   */
  ```

如果需要自定义上面注释信息，需要在 VSCode setting.json 文章中添加配置，下面字段可以自行添加移除或者自定义字段：

"fileheader.customMade": {
    "Author":"DZM",
    "Date": "Do not edit", // 文件创建时间(不变)
    "LastEditors": "[you name]", // 文件最后编辑者
    "LastEditTime": "Do not edit", // 文件最后编辑时间
    "Description":""
    // "dzmtest": ""
}

/*
 * @Author: DZM
 * @Date: 2021-03-25 15:19:05
 * @LastEditors: [you name]
 * @LastEditTime: 2021-04-02 13:19:32
 * @Description: 
 */

在光标处添加函数注释：

使用方式：选中函数名或光标在函数名上方按快捷键即可

快捷键： window：ctrl + alt + t，mac：ctrl + cmd + t

/**
 * @description: 
 * @param {Request} $request
 * @return {*}
 */
public function save(Request $request) {
    dump($request->all());
}

如果需要自定义上面注释信息，需要在 VSCode setting.json 文章中添加配置，下面字段可以自行添加移除或者自定义字段：

"fileheader.cursorMode": {
    "Author":"[you name]",
    "description": "", 
    "param": "", 
    "return":""
    // "dzmtest": ""
}


/**
 * @Author: [you name]
 * @description: 
 * @param {Request} $request
 * @return {*}
 */
public function save(Request $request) {
    dump($request->all());
}

根据不同开发语言自定义注释：

// 设置
"fileheader.configObj": {
    "language": {
        // 普通后缀文件
        "js": {
            "head": "/$$",
            "middle": " $ @",
            "end": " $/",
            // 函数自定义注释符号：如果有此配置 会默认使用
            "functionSymbol": {
              "head": "/******* ", // 统一增加几个*号
              "middle": " * @",
              "end": " */"
            }
        },
       // 一次匹配多种文件后缀文件 不用重复设置
       "h/hpp/cpp": {
          "head": "/*** ", // 统一增加几个*号
          "middle": " * @",
          "end": " */"
        },
        // 针对有特殊要求的文件如：test.blade.php
        "blade.php":{
          "head": "<!--",
          "middle": " * @",
          "end": "-->",
        }
    }
}

本文参与腾讯云自媒体同步曝光计划，分享自作者个人站点/博客。

原始发表：2024-09-03，如有侵权请联系 cloudcommunity@tencent.com 删除

开发