使用Goanno插件自动生成注释

依次打开“File -> Settings -> Plugins”，输入“Goanno”搜索出插件然后将其安装即可。

 

把光标移到要生成注释的方法（或函数）的上一行，按快捷键“Ctrl＋Alt＋/”即可生成注释。

 

 

 

 

 

Goanno默认的方法（或函数）注释模板如下：

 

------------------------- 分割线 -------------------------

//

// ${function_name}

//  @Description: ${todo}

//  @receiver ${receiver}

//  @param ${params}

//  @return ${return_types}

//

------------------------- 分割线 -------------------------

 

 

 

 

 

开发者也可以依次打开“Tools -> Goanno Setting”修改注释模板。

 

------------------------- 俺の注释模板 -------------------------

------------------------- 俺の注释模板 -------------------------

package main

import "fmt"

///////////////////////////////////////////////////////
// 下面的Foo()函数的注释就是使用Goanno插件自动生成的 //
///////////////////////////////////////////////////////

// Foo
// @description 方法或函数的功能说明
// @author 码农人生<1104187@qq.com>
// @date 2008-08-08 08:08:08
// @param name string 参数说明
// @param gender string 参数说明
// @param age int64 参数说明
// @return profile map[string]any 返回值说明
func Foo(name string, gender string, age int64) (profile map[string]any) {
   profile = map[string]any{}

   profile["name"] = name
   profile["gender"] = gender
   profile["age"] = age

   return
}

func main() {
   profile := Foo("张三", "男", 18)

   name := profile["name"]
   gender := profile["gender"]
   age := profile["age"]

   fmt.Printf("俺叫%s（%s），今年%d岁。\n", name, gender, age) // 俺叫张三（男），今年18岁。
}