VsCode插件koroFileHeader一键添加文件头部注释

时间:2022-07-28
本文章向大家介绍VsCode插件koroFileHeader一键添加文件头部注释,主要内容包括其使用实例、应用技巧、基本知识点总结和需要注意事项,具有一定的参考价值,需要的朋友可以参考一下。

koroFileHeader

koroFileHeader是为Vscode开发的插件,在 VsCode 中通过快捷键ctrl+alt+i在文件头部添加注释。

插件是参照 vscode-fileheader扩展并增加了用户自定义注释功能。

language

English | 简体中文

简介

  • vscode扩展插件
  • 在文件头中添加注释
  • 支持用户自定义文件注释模板
  • 在你保存文件的时候 自动更新编辑时间

安装

在 Vscode 扩展商店中搜索 koroFileHeader

使用

  1. 在 Vscode 中打开文件
  2. ctrl+alt+i

成功在文件头部插入文件注释

注释模板

默认注释模板

  • 默认配置: "fileheader.customMade": { "Author": "OBKoro1", "Date": "Do not edit", "Email": "obkoro1@foxmail.com", "LastEditors": "OBKoro1", "LastEditTime": "Do not edit", "Description": "file information", "Company": "your company" }
  • 文件注释生成: /* * @Author:OBKoro1 * @Date:2018-05-15 16:20:04 * @Email:obkoro1@foxmail.com * @LastEditors:OBKoro1 * @LastEditTime:Do not edit * @Description:file information * @Company:your company */

自定义注释模板

  1. 在 VsCode 设置中搜索fileheader.customMade
  2. 复制默认配置+修改配置
  3. 重启 VsCode 生效

Example

  • 设置:
  • 文件注释生成: /* * @Author: OBKoro1 * @Date: 2018-05-15 20:08:15 * @Email: obkoro1@foxmail.com * @LastEditors: OBKoro2 * @LastEditTime: 2018-05-15 20:08:15 * @Description: file information * @Company: your company * @youWant: you want info */

自动更新编辑时间 示例:

微信公众号

关注我的微信公众号,每月会发几篇技术博客,有问题可以一起交流,相互学习,共同进步。

LICENSE

MIT