VsCode 添加文件头部注释和函数注释[koroFileHeader]

superPershing 发布于2019-08-23 12:23 / 3817人阅读

摘要：使用文件头部注释在当前编辑文件中使用快捷键即可生成文件头部注释。函数注释将光标放在函数行或者将光标放在函数上方的空白行使用快捷键，即可生成函数注释。事实上，函数注释在文件的任意位置都可生成，这里需要自己控制。

koroFileHeader

一个读取用户自定义模板，通过快捷键添加文件头部注释、在光标处添加函数注释的VsCode插件

language

简体中文 | English

更新日志

更新日志

常见问题

简介

文件头部添加注释:

在文件开头添加注释，记录文件信息

支持用户高度自定义注释选项

保存文件的时候，自动更新最后的编辑时间和编辑人

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

在光标处添加函数注释:

在光标处自动生成一个注释模板，下方有栗子

支持用户高度自定义注释选项

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

快捷键不可用很可能是被占用了,参考这里

支持不同语言的注释格式，如下。

支持注释格式：

头部注释和函数注释目前支持以下两种形式的注释：

/**/形式，默认情况下将生成此类注释：

/*
 * @Description: 
 * @Author: OBKoro1
 * @Date: 2018-08-20 00:26:26
 * @LastEditors: OBKoro1
 * @LastEditTime: 2018-11-01 10:34:14
 */

"""形式,读取.py后缀，自动生成python形式注释，无需配置：

"""
@Description: 
@Author: OBKoro1
@Date: 2018-10-24 21:57:52
@LastEditors: OBKoro1
@LastEditTime: 2018-11-01 10:35:54
"""

安装

在 Vscode 扩展商店中搜索koroFileHeader,点击安装即可。

使用

文件头部注释：

在当前编辑文件中使用快捷键:window：ctrl+alt+t/mac：ctrl+cmd+t,即可生成文件头部注释。

函数注释：

将光标放在函数行或者将光标放在函数上方的空白行

使用快捷键window：ctrl+alt+t,mac：ctrl+cmd+t，即可生成函数注释。

事实上，函数注释在文件的任意位置都可生成，这里需要自己控制。

注释模板的设置

默认配置:

在用户首选项中搜索fileheader，默认配置为：

   "fileheader.customMade": {} // 头部注释
   "fileheader.cursorMode": {} // 函数注释

用户未设置的情况下，头部注释和函数注释模板为：

自定义模板：

在用户设置中，搜索fileheader

复制默认配置+修改配置,重启生效

如上设置，生成注释：

// 文件头部注释
/*
 * @Description: 
 * @version: 
 * @Company: BAT
 * @Author: OBKoro1
 * @Date: 2018-10-15 20:59:57
 * @LastEditors: OBKoro1
 * @LastEditTime: 2018-10-15 20:59:57

     */
    // 函数注释
    /**
     * @name: 
     * @test: test font
     * @msg: 
     * @param {type} 
     * @return: 
     */

自动更新最后编辑时间、编辑人：

要开启这个功能，需要在首选项设置中填写对应的属性：

  "fileheader.customMade": {
    "Date": "Do not edit", // 文件创建时间(不变)
    "LastEditors": "OBKoro1", // 文件最后编辑者
    "LastEditTime": "Do not edit" // 文件最后编辑时间
  }
  // 不填写对应属性即关闭对应功能

自动更新编辑时间

示例:

最后

如果觉得还不错的话，就给个 Star ⭐️ 鼓励一下我吧~

博客、前端积累文档、公众号、GitHub

云服务器 GPU云服务器函数注释为啥html添加注释 java函数注释格式 java整段添加注释

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/98439.html

koroFileHeader 非常实用的Vscode 插件[用于添加文件头部注释]

摘要：使用文件头部注释在当前编辑文件中使用快捷键即可生成文件头部注释。事实上，函数注释在文件的任意位置都可生成，这里需要自己控制。 koroFileHeader 一个读取用户自定义模板，通过快捷键添加文件头部注释、在光标处添加函数注释的VsCode插件 language 简体中文 | English 一些文档支持语言插件设置/配置更新日志常见问题简介文件头部添加注释: 在文...

hoohack 2019-08-22 17:21 评论0 收藏0
VS code-前端配置_022

摘要：前端配置简体中文插件，一般会自动识别你的环境，自动提示是否需要简体中文的语言包。使用插件将目前配置保存到上，以后只需要从上获取，就可以一次性安装插件配置信息。 VS code-前端配置 showImg(https://segmentfault.com/img/bVbuK6l?w=1224&h=999); Chinese (Simplified) Language Pack for Vi...

cyrils 2019-08-23 18:31 评论0 收藏0
vscode常用插件【全了】

摘要：插件集待补充。。。同时，它还包含了用于转换为格式和生成数据模式的选项用于压缩合并和文件的应用程序。它提供了大量自定义的设置，以及自动压缩保存并导出为文件的选项。修改文本的更多命名格式，包括驼峰命名下划线分隔命名，命名以及命名等切换漂亮的主题插件集待补充。。。 20180903 文件【Path Intellisense】自动补全路径浏览器【Open-In-Browser】在...

kyanag 2019-08-30 13:57 评论0 收藏0
vscode常用插件【全了】

摘要：插件集待补充。。。同时，它还包含了用于转换为格式和生成数据模式的选项用于压缩合并和文件的应用程序。它提供了大量自定义的设置，以及自动压缩保存并导出为文件的选项。修改文本的更多命名格式，包括驼峰命名下划线分隔命名，命名以及命名等切换漂亮的主题插件集待补充。。。 20180903 文件【Path Intellisense】自动补全路径浏览器【Open-In-Browser】在...

xcc3641 2019-08-26 11:42 评论0 收藏0