前言
本来之前也安装过一个头部文件注释的插件:vscode-fileheader
,由于插件的注释模板都是定死的,想要自己定制一些模板注释也不行,实在用的不舒服,然后自己去研究了一番,参考vscode-fileheader
插件的一些内容,开发了这个插件。
koroFileHeader
在 VsCode 中通过快捷键ctrl+alt+i
在文件头部添加注释。
language
English | 简体中文
简介
- vscode扩展插件
- 在文件头中添加注释
- 支持用户自定义文件注释模板对象
- 在你保存文件的时候 自动更新编辑时间
安装
在 Vscode 扩展商店中搜索 koroFileHeader
使用
- 在 Vscode 中打开文件
- 按
ctrl+alt+i
成功在文件头部插入文件注释
注释模板
默认注释模板
-
默认配置:
"fileheader.customMade": { "Author": "OBKoro1", "Date": "Do not edit", "LastEditors": "OBKoro1", "LastEditTime": "Do not edit", "Description": "", }
-
文件注释生成:
/* * @Author:OBKoro1 * @Date:2018-05-15 16:20:04 * @LastEditors:OBKoro1 * @LastEditTime:2018-05-15 16:20:04 * @Description: */
推荐模板参数
Email
、Company
、version
等.
自定义注释模板
- 在 VsCode 设置中搜索
fileheader.customMade
- 复制默认配置+修改配置
- 重启 VsCode 生效
Example
- 设置:
-
文件注释生成:
/* * @Author: OBKoro1 * @Date: 2018-05-16 12:33:57 * @LastEditors: OBKoro1 * @LastEditTime: 2018-05-16 12:33:57 * @Description: * @Email: your Email * @Company: your company * @youWant: add you want */
自动更新编辑时间 示例:
作者:OBKoro1
链接:https://www.imooc.com/article/29921
来源:慕课网