写在前面
这是我从 https://github.com/OBKoro1/koro1FileHeader 项目fork来的,这是个非常棒的项目。但因为原项目不支持golang的多种不同场景的入参和出参(这些内容其实也是我在开发过程中主要解决的case),基于以下这些不支持的场景,我fork出来自己开发了一下,所以主要针对golang。
包括不限于:
- 不支持golang的多返回参数(这也是golang特有的)
func() (int, string, error)
- 不支持golang的入参-连续多个相同类型
func (name string, age, height, weight int)
- 不支持golang的入参-变长参数
func (multi ...int)
- 不支持golang的参数-结构体的字段
type Person struct {
BaseInfo PersonBaseInfo
Phone string
Address string
}
type PersonBaseInfo struct {
Name string
Age int
Height int
}
func (name string) (baseInfo Person.BaseInfo, err error)
- 不支持golang参数-指针类型
func (ctx *gin.Context, namePrt *string, agePtr *int) (error)
- 不支持golang参数-切片类型
func (ctx *gin.Context, sli []string, multiSli [][]string) (error)
等等
另外,我正在努力联系原作者希望可以把我的代码提交到原仓库,希望原作者如果看到这个项目,可以和我联系,谢谢!
我的代码仓库
食用方式
- 下载安装vscode
- 搜索插件"koroFileHeader-for-go"并安装
- 配置插件
- 食用
如果有任何问题,欢迎提issue或者联系我!
(下面基本都是原项目的内容了)
简介
- VSCode插件: 用于一键生成文件头部注释并自动更新最后编辑人和编辑时间、函数注释自动生成和参数提取。
- 插件可以帮助用户养成良好的编码习惯,规范整个团队风格。
- 从2018年5月维护至今, 关闭issue 500+ ,拥有39.7w+的用户,VSCode图表统计日均安装200-500
- 经过多版迭代后,插件支持所有主流语言,灵活方便,文档齐全,食用简单!
- 觉得插件不错的话,就给个Star⭐️吧~
主要功能
- 自动生成文件头部注释,自动更新最后编辑人、最后编辑时间等。
- 一键生成函数注释,支持函数参数自动提取并列到注释中。
- 支持添加佛祖保佑永无bug、神兽护体、甩葱少女等好玩有趣的图像注释
- 配置非常灵活方便,各种细节都能配置,可以量身打造适合你的注释。
- 支持所有主流语言, 配置文档非常详细,齐全。
使用效果:
头部注释和注释图案
函数注释: 自动提取函数参数
- 支持主流语言自动提取函数参数
- 多行函数参数支持自动提取
注释图案
支持一键添加佛祖保佑永无BUG、神兽护体等注释图案
安装和快速上手
安装和快速上手
快速查看插件功能与配置方法
功能目录:查看配置右侧自动生成的markdown目录,浏览所有最新最全的功能。
配置简介:配置字段
Wiki文档
安装和快速上手
支持语言
插件设置/配置
配置字段
更新日志
常见问题
佛祖保佑永无BUG、神兽护体等注释图案
我的其他开源推荐
减少摸鱼的时间和频率的Chrome插件:在上班/学习期间很容易下意识的打开摸鱼网站,插件帮助我们减少摸鱼的时间和频率,提高我们上班和学习的效率,节省时间用于学习提升自己或者享受生活。
这是一个用于Git自动commit的VSCode插件,它可以用来补充之前忘记提交commit,帮助你把首页的绿色格子填满。
收集和整理了一个大厂前端需要掌握能力的仓库。
其中分为JS基础能力,大厂场景题、大厂面试真题。
希望能够帮助大家提升自己的能力,在面试的时候能够游刃有余,轻松拿到高薪offer。
用爱发电,求赞助 😭
开源不易,本插件的开发与维护全都是利用业余时间。
如果觉得这个效率工具还不错, 对你有所帮助,就赞助支持一下我的工作吧。
请我喝杯水吧,十块八块不嫌多,三块五块不嫌少 ❤️
License
MIT
求Star
如果觉得还不错的话,就给个 Star ⭐️ 鼓励一下我吧~
联系我
掘金、前端进阶积累、公众号、GitHub、微信:OBkoro1、邮箱:obkoro1@foxmail.com