VSCode KoroFileHeader 注释插件(支持多种语言,可自定义)

简介: VSCode KoroFileHeader 注释插件(支持多种语言,可自定义)

一、简介

  • 官方快速上手文档GitHub 地址
  • KoroFileHeader 是一款用于在 VSCode 中用于生成文件头部注释和函数注释的插件,支持所有主流语言,功能强大,灵活方便,文档齐全。
  • VSCode 安装 KoroFileHeader 好插件,就可以直接使用。
"fileheader.customMade": {} // 头部注释
"fileheader.cursorMode": {} // 函数注释 
"fileheader.configObj": {}  // 插件配置项

二、使用

  • 关闭自动添加头部注释,需要在 VSCode setting.json 文章中添加配置:
"fileheader.configObj": {
    "autoAdd": false, // 关闭自动生成头部注释
}

  • 文件头部添加注释:
    使用方式:进入当前页面 按快捷键即可
    快捷键: windowctrl + alt + imacctrl + 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: 
 */

  • 在光标处添加函数注释:
    使用方式:选中函数名光标在函数名上方 按快捷键即可
    快捷键: windowctrl + alt + tmacctrl + 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": "-->",
        }
    }
}

相关文章
|
6天前
|
人工智能 小程序 程序员
【视频测评 DEMO 参考】VSCode 神级 AI 插件通义灵码:完全免费+实战教程+微信贪吃蛇小程序
VSCode 神级 AI 插件通义灵码:完全免费+实战教程+微信贪吃蛇小程序
153 7
|
8天前
|
机器学习/深度学习 人工智能 自然语言处理
|
2月前
|
前端开发 搜索推荐 C++
Marp 教程:如何在 VSCode 中引入自定义样式和主题
本文介绍了如何在 Marp 中引入自定义样式和主题,使你的幻灯片更加个性化和独特。首先,你需要安装 VSCode 和 Marp 插件,了解 Marp 的基本结构。接着,通过创建自定义 CSS 文件并在 Markdown 文件中引入,实现样式定制。此外,还可以创建和使用自定义主题,以及进行高级自定义,如调整布局、引入自定义字体和定义复杂动画。最后,使用 Marp 的预览功能实时查看效果。
141 0
|
3月前
|
自然语言处理 API C++
阿里通义推出SmartVscode插件,自然语言控制VS Code,轻松开发应用,核心技术开源!
SmartVscode插件深度解析:自然语言控制VS Code的革命性工具及其开源框架App-Controller
|
3月前
|
开发工具 C++ git
利用VS Code提升开发效率的五大插件推荐
本文推荐了五款能显著提升开发效率的VS Code插件:ESLint用于代码质量和风格检查;Prettier自动格式化代码;GitLens增强Git功能;Live Server提供前端实时预览;Docker支持容器管理。
|
4月前
|
自然语言处理 JavaScript 开发者
通义灵码插件:VSCode 的智能编程助手
通义灵码插件:VSCode 的智能编程助手
1847 3
|
4月前
|
前端开发 JavaScript 编译器
2024最新VSCode实用插件推荐,开发效率遥遥领先!超全面,快收藏~
【10月更文挑战第11天】2024最新VSCode实用插件推荐,开发效率遥遥领先!超全面,快收藏~
1117 0
2024最新VSCode实用插件推荐,开发效率遥遥领先!超全面,快收藏~
|
5月前
|
人工智能 C++ 开发者
verilog vscode 与AI 插件
【9月更文挑战第11天】在Verilog开发中,使用Visual Studio Code(VS Code)结合AI插件能显著提升效率。VS Code提供强大的编辑功能,如语法高亮、自动补全和代码格式化;便捷的调试功能,支持多种调试器;以及丰富的插件生态。AI插件则可自动生成代码、优化现有代码、检测并修复错误,还能自动生成文档。常用插件包括Verilog AI Assistant和Verilog Language Server,可根据需求选择合适的工具组合,提高开发效率和代码质量。
390 2
|
6月前
|
前端开发 Go
vscode10大常用插件
本文介绍了前端开发中常用的工具及VSCode必备插件。推荐使用VSCode作为入门工具,并介绍了WebStorm和HBuilder等其他选项。VSCode插件包括:Open-In-Browser、live-server、Beautify、Code Runner、Image Preview、Path Intellisense、Turbo Console Log、css-auto-prefix、Bracket Pair Colorizer 和 Auto Rename Tag,这些插件能够显著提升开发效率和代码质量。此外,还提供了录制Gif图的工具GifCam。
197 5
|
6月前
|
前端开发 IDE 开发工具
OpenSumi问题之OpenSumi 对于 VS Code 插件生态要如何支持
OpenSumi问题之OpenSumi 对于 VS Code 插件生态要如何支持
154 6

热门文章

最新文章