GoComment is a VSCode extension that automatically generates comments for GO functions, variables, structs. It can auto fix function name etc.
使用默认模版可以生成满足golint要求的注释，可以根据函数名的相似度来纠正拼写错误或者修改的函数名，变量名，参数名等。需要注意的是当参数名之间很相似的时候，可能会获取到错误的注释。
可在vscode扩展插件中搜索 GoComment。
本仓库(https://github.com/0x00b/vscode-go-comment
)是vscode版本，对应的goland版本地址 https://github.com/0x00b/golandanno 。
How to use
- control + command + / (For windows: control + alt + /)
config template
-
- shift+command+p -> open setting (
json)
-
- add line
"functionTemplate": "// ${func_name} \n//\t@param ${param_name} \n//\t@return ${return_name} ",
-
- add line
"typeTemplate": "// ${type_name} "
建议：模板中的缩进使用\t
推荐使用默认注释，满足Golang godoc注释规范，满足golint默认扫描规则。
使用godoc查看注释效果如下：
godoc -http=localhost:6060
Getting started
模板说明
如果开启了保存时自动格式化代码，则对模板有一定要求。
比如下面的模板，可能在保存时会被改变：
{
"functionTemplate": "// ${func_name} \n// @receiver ${receiver_name} \n// @param ${param_name} \n// @return ${return_name} \n// @author ${git_name} \n// @date ${date}",
}
原因是第一行的注释是 "// ", 后面是一个空格，后面的行的注释开头//后面是两个空格，gofmt认为第一行的注释和后面的注释风格不一样，会被gofmt主动加上tab键，导致最终格式变化。
QA
为了防止保存时自动格式化不会修改注释的格式，该怎么办？
答案很简单，保持需要挨在一起的行之间使用相同的缩进。
比如下面的注释在保存时会被自动重新格式化，导致图案混乱，图案每一行开头的空格数都不一样，并且在输入过程中有些使用了\t，有些使用了空格，导致自动保存时认为注释缩进不一样，会重新格式化注释，导致图案混乱。
为了区别空格和\t，用 → 代替 \t
// Error 报错显示
// ***************************************************
// **************** Mercy Buddha *********************
//
//→ _oo0oo_
// o8888888o
//→→ 88 . 88
// (| -_- |)
//→ 0\\ = /0
//→→ ___/ --- \\___
//→ .' \\\\| |// '.
// / \\\\||| : |||// \\
//→ / _||||| --- |||||- \\
// | | \\\\\\ - /// | |
//→ | \\_| ”\\\\---//” |_/ |
// \\ .-\\__ '-' ___/-. /
// → ___'. .' /--.--\\ . .'___
//→→ . '< .___\\_<|>_/___.' >' .
// | | \\ .; \\ ;. | |
//→ \\ \\ . \\ - -\\ -- - -.- / /
// ===== -.____ .___ \\_____/___.- ___.-'=====
//→ =---='
//
// ***************************************************
// ***************************************************
//
// @param ctx
// @param req
// @return rsp
// @return err
func Error(ctx context.Context, req *pb.IndexRequest) (rsp *pb.IndexReply, err error)
解决方案：
在图案每行开头都使用相同的缩进 "// *", 使得每一行的缩进都相同，则不会被重新格式化，如下：
// Error ERR 报错显示
// *************************************************************
// ********************* Mercy Buddha **************************
// * *
// * _oo0oo_ *
// * o8888888o *
// * 88 . 88 *
// * (| -_- |) *
// * 0\\ = /0 *
// * ___/ --- \\___ *
// * .' \\\\| |// '. *
// * / \\\\||| : |||// \\ *
// * / _||||| --- |||||- \\ *
// * | | \\\\\\ - /// | | *
// * | \\_| ”\\\\---//” |_/ | *
// * \\ .-\\__ '-' ___/-. / *
// * ___'. .' /--.--\\ . .'___ *
// * . '< .___\\_<|>_/___.' >' . *
// * | | \\ .; \\ ;. | | *
// * \\ \\ . \\ - -\\ -- - -.- / / *
// * ===== -.____ .___ \\_____/___.- ___.-'===== *
// * =---=' *
// * *
// *************************************************************
// *************************************************************
//
// @param ctx
// @param req
// @return rsp
// @return err
func Error(ctx context.Context, req *pb.IndexRequest) (rsp *pb.IndexReply, err error)
How to install
1.vscode plugins marketplace(search GoComment)
special tag, represent beginning of a special line.
- @receiver ： golang function receiver
- @param ： golang function parameter
- @return ： golang function return parameter
- @author ： author name, or use ${git_name}
- @date ： use ${date}, if not set, use current date
- @update ： update tag, maybe config as
"${git_name} ${date}", update "${date}" always
support variable
func (r receiver)Foo(i interface{}) (e error)
* ${func_name} : function name is "Foo".
* ${receiver_name} : will be replaced by "r".
* ${receiver_type} : will be replaced by "receiver".
* ${receiver_name_type} : will be replaced by "r receiver".
* ${param_name} : "i"
* ${param_type} : "interface{}"
* ${param_name_type} : "i interface{}"
* ${return_name} : "e"
* ${return_type} : "error"
* ${return_name_type} : "e error"
* ${package_name} : package name
* ${type_name} : type Int int64, ${type_name} is "Int"
* ${var_name} : var n int, ${var_name} is "n"
* ${var_type} : var n int, ${var_type} is "int"
* ${date} : date
* ${git_name}: git config name
how to build and publish
vsce login publisher #login first, if need
vsce package
vsce publish
