koro1FileHeader
koro1FileHeader copied to clipboard
OBKoro1
VSCode插件：自动生成，自动更新VSCode文件头部注释, 自动生成函数注释并支持提取函数参数，支持所有主流语言，文档齐全，使用简单，配置灵活方便，持续维护多年。
**想要支持新的语言：** 语言：md类型文件 目前插件生成的模板: ```md --- author : xxx Date : 2023-11-24 23:14:51 +0800 LastEditors : xxx date : 2023-11-25 00:09:46 +0800 FilePath : xxx Description : QQ : xxx Copyright...
问题： 方法注释不能自动提取方法里面的参数 新语言背景： salesforce apex语言就是java封装的，只是class文件的后缀名是cls，不是java 期望解决的问题： 我需要如何配置才能在对方法进行注释的时候自动提取方法里面的参数
**想要支持新的语言：** 语言：C 目前插件生成的模板: ```js // 函数注释 "fileheader.cursorMode": { "description ": "", // 函数注释生成之后，光标移动到这里 "param": "", // param 开启函数参数自动提取 需要将光标放在函数行或者函数上方的空白行 "return": "", "author": "RensLi", // 创建文件的作者 "Date": "Do not edit", //...
### 描述bug(必填) 在SpringBoot中，如果函数参数采用Restful风格，函数参数前面会带有注释如@PathVariable、@RequestBody，这种情况下插件解析不出参数 **注释设置(必填):** VsCode设置： ```js "fileheader.customMade": { }, "fileheader.cursorMode": { "description": "", // 函数注释生成之后，光标移动到这里 "param": "", // param 开启函数参数自动提取 需要将光标放在函数行或者函数上方的空白行 "return": "", "author": "sirius", }, "fileheader.configObj": { "autoAdd": false,...
### 注意！很多问题都可以在[配置字段查看所有配置](https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE%E5%AD%97%E6%AE%B5)中和issue里得到解决！ ### 注意！很多问题都可以在[配置字段查看所有配置](https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE%E5%AD%97%E6%AE%B5)中和issue里得到解决！ ### 注意！很多问题都可以在[配置字段查看所有配置](https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE%E5%AD%97%E6%AE%B5)中和issue里得到解决！ ### 注意： 1. 可以先试一下常见问题中的方法. 2. 然后搜一搜以前关闭的issue看有没有相似的问题可以帮助解决问题。 3. 打开`fileheader.configObj.showErrorMessage`看看没有没有报错信息 4. issue提的越清晰，越容易定位问题/找到bug，越快速的解决问题。 #### 注意！请一定要按照规范来提Issue，这样问题能更快的得到解决！ #### 注意！请一定要按照规范来提Issue，这样问题能更快的得到解决！ #### 注意！请一定要按照规范来提Issue，这样问题能更快的得到解决！ ### 描述bug(必填) 一个清楚而简洁的bug描述。 **注释设置(必填):** VsCode设置： ```js // 配置填在这里面...
### 注意！很多问题都可以在[配置字段查看所有配置](https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE%E5%AD%97%E6%AE%B5)中和issue里得到解决！ ### 注意！很多问题都可以在[配置字段查看所有配置](https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE%E5%AD%97%E6%AE%B5)中和issue里得到解决！ ### 注意！很多问题都可以在[配置字段查看所有配置](https://github.com/OBKoro1/koro1FileHeader/wiki/%E9%85%8D%E7%BD%AE%E5%AD%97%E6%AE%B5)中和issue里得到解决！ ### 注意： 1. 可以先试一下常见问题中的方法. 2. 然后搜一搜以前关闭的issue看有没有相似的问题可以帮助解决问题。 3. 打开`fileheader.configObj.showErrorMessage`看看没有没有报错信息 4. issue提的越清晰，越容易定位问题/找到bug，越快速的解决问题。 #### 注意！请一定要按照规范来提Issue，这样问题能更快的得到解决！ #### 注意！请一定要按照规范来提Issue，这样问题能更快的得到解决！ #### 注意！请一定要按照规范来提Issue，这样问题能更快的得到解决！ ### 描述bug(必填) python 函数注释无法识别 模块.类 变量类型 **注释设置(必填):** VsCode设置：...
目前 fileheader.customMade 的配置中，只解析了${now_year}。能否新增${now} 或者 {time}来替换为当前时间呢？因为在大多数自定义key中的value会使用时间。eg：下图为自定义模板生成的头注释，其中${now}无法没被解析替换。其实可以在changeTplValue 多解析个占位符。 ``` "fileheader.customMade": { "custom_string_obkoro1": "this_is_name ${now}", "custom_string_obkoro1_copyright": "Copyright (c) ${now_year} by Txxx, All Rights Reserved. " } ``` ``` // // this_is_name ${now} //...
目前插件生成的模板: ```js /***************************** /* * @Author: XXX * @Date: 25-July-2023 */ *****************************/ ``` 提供你最终想要的注释模板: ```js /***************************** * @Author: XXX * @Date: 25-July-2023 *****************************/ ``` **描述一下你想要的解决方案.** 我希望头部注释的前后插入内容配置应该是替换默认的前后缀，而不是在外面再套一层
