2021-01-22goland函数注释生成插件

goland函数注释生成插件

• goanno
• 使用方式

 

网上存在很多如何使用goland生成函数注释模版的介绍，比如有介绍在Live Template中编写。

可以参考这篇文章配置Preferences | Editor | Live Templates 配置文档

先说一下，可以生效，但是前提是你的光标在函数内，不能放在函数头部，并且生成的注释也在函数内部，之后需要手动复制出来。除此之外，goland的一些特性比如函数接受者，多个return都无法支持。

由于目前暂时没有发现一个完全可以使用用的方案，所以抽空简单写了一个自动生成goland注释的插件，目前已经有400+的下载用户使用。

goanno

可以通过goland或者idea的插件市场通过搜索goanno下载。
也可以直接通过如下的网址下载release包，通过本地安装插件安装。
https://plugins.jetbrains.com/plugin/14988-goanno
https://github.com/loveinsky100/goanno

完美支持goland的函数注释，包括interface/普通函数/函数接受者/多个出参

使用方式

目前有两种方式
生成注释
1.快捷键control + commond + / （windows用户快捷键配置参考:GoLand 快速添加方法注释）
2.手动生成：鼠标右键 -> 选择Generate -> 选择Goanno

PS：如果快捷键位不舒服，特别是windows用户，请告知可以调整健位

调整模版（默认模版为java样式，可以通过修改模版调整成golang官方推荐的样式）
选择导航栏"Tools - Goanno Setting"

•