GoLand不支持保存时自动生成函数文档，仅可通过Live Template（如funcdoc）配合Groovy脚本手动触发生成注释骨架，提取参数与返回值；File Watchers或插件均无法可靠识别新增函数，且必须人工补全语义描述、副作用说明等关键内容。
GoLand 本身不提供“保存即自动生成函数文档”的功能，也没有内置的 godoc 注释生成器；所谓「配置文档自动生成工具」，实际是配置快捷键触发的 Live Template，配合手动确认完成注释骨架搭建——这是目前唯一稳定、可控、不破坏已有代码的方式。
用 Live Template 配 funcdoc 模板（推荐）
GoLand 的 go:func 模板默认存在，但只生成空注释块；要支持自动提取参数名、类型和返回值，必须新建一个带 Groovy 脚本变量的模板：
- 进入 Settings → Editor → Live Templates → Go，点击 + → Live Template
-
Abbreviation填funcdoc（或你喜欢的缩写） -
Template text填：// $DESCRIPTION$ // @param $PARAMS$ // @return $RETURNS$
- 在 Edit variables 中设置：
-
DESCRIPTION→groovyScript("''")（留空，方便手填语义） -
PARAMS→groovyScript("def params = _1.collect { it.name + ' ' + it.type }; params.join(', ')") -
RETURNS→groovyScript("def rets = _1.collect { it.type }; rets.join(', ')")
-
- 务必把 Applicable in 设为
Go function declaration，否则变量无法解析
为什么不能设成“保存时自动运行”
File Watchers 或外部脚本强行绑定保存动作，会遇到几个硬伤：
- GoLand 无法可靠识别「新增函数」——它没 API 告诉你哪一行是刚写的、哪一行是改的
- 正则匹配
func \w+\(.*\)极易误判：比如匹配到函数体内的func() {}匿名函数，或 struct 方法声明 - 重复插入：同一函数保存多次，可能生成多份
// @param，破坏 godoc 解析 - 参数类型提取失败：Groovy 变量
_1在非声明上下文里是 null，导致@param undefined
插件 GoDoc Assistant 能做什么、不能做什么
第三方插件 GoDoc Assistant 提供右键菜单 Generate GoDoc comment，比纯 Live Template 多两点优势：
Golang Uber Dig
下载
使用 uber-go/dig 在 Golang 中实现依赖注入——基于反射容器，提供 Provide/Invoke、dig.In/dig.Out 参数与结果对象，支持命名依赖等
立即学习“go语言免费学习笔记（深入）”；
- 能识别指针参数（如
*string）并保留符号，而默认 Groovy 脚本可能丢掉* - 支持快捷键绑定（如
Alt+D），可在 Keymap 中关联到Save Document，但不建议启用
它不会覆盖已有注释，也不会静默执行——这点比脚本方案安全。但注意：GoDoc Assistant 不维护 go.mod，且仅适配到 GoLand 2026.x，若你用的是 2027 预览版，大概率失效。
生成后还要人工补什么
无论用哪种方式，IDE 只能搭骨架，以下内容必须人来填：
-
// $DESCRIPTION$行：函数意图、边界条件（如「当s为 nil 时返回空字符串」） -
@param后的说明：不是只写name string，而是name 用户姓名，长度不超过 32 字符 - 副作用说明：是否修改入参、是否并发安全、是否 panic
- 示例片段：godoc 会识别
ExampleXXX函数，但 IDE 不帮你生成
真正影响 go doc 和 pkg.go.dev 文档质量的，从来不是注释有没有，而是这些细节有没有写对、写全。
