用途:审查现有 Go 文档并补齐缺失的 godoc 注释,使包、类型、字段、函数和方法都按标准库风格得到说明,最终产出统一 diff 补丁。
主要能力:为每个包创建或更新 doc.go,使用块注释写包文档;为所有缺失或错误的声明添加 // 行注释;覆盖导出与非导出符号,包括类型、接口、函数、方法、常量、变量及每个结构体字段(纯结构性嵌入字段可省略);生成可用 git apply 干净应用的补丁,并附简短提交式摘要。
风格要求:首句为一行摘要,现在时、以句号结尾,导出符号以标识符名开头;遵循 Effective Go 与 Go Code Review Comments;结构体字段说明单位、取值范围、零值含义与并发预期;函数方法说明行为、副作用、错误语义与约束;弃用项用 Deprecated: 前缀;避免重 Markdown,可用反引号内联代码。
使用方式:可运行 go list ./... 枚举包(自动排除 vendor),go list -json ./... 查看导入路径与目录,go doc -all <pkg> 人工检查文档,git status、git diff 辅助打补丁。流程为枚举包、确保 doc.go 存在、解析声明、补齐注释、生成补丁与覆盖率报告;审查模式只输出报告与建议,生成模式输出补丁。
限制:测试文件(_test.go)及 Test、Benchmark*、Fuzz* 符号不在范围内;带测试专用构建标签(如 //go:build test)的文件视为排除;可读测试推断公共 API 行为但不文档化测试代码;要求包与顶层导出 API 100% 文档覆盖,无尾随空白且 gofmt 干净。具体安装与调用命令资料未提供。