SuperAPI AI 工具集

go-documentation

写作与研究

查看项目

更新于 10-16 05:04

技能介绍

用途:在编写或审查 Go 包、类型、函数、方法文档时使用,也可在新建导出类型、函数或方法时主动应用,确保 Godoc 注释规范完整。

主要能力:提供文档注释规范(以被描述对象名称开头、使用完整句子、首字母大写并加标点);要求所有顶层导出名称必须有文档注释,未导出但行为不明显的类型或函数也应注释;每个包必须有且仅有一个包注释,长注释可用 doc.go;结构体字段可用分组注释并标注可选字段默认值;建议在测试文件中提供可运行的 Example 示例,示例会出现在 Godoc 中。

使用方式:运行 bash scripts/check-docs.sh 检查导出函数、类型、方法、常量和包是否缺少文档注释;scripts/check-docs-ast.go 为其实现辅助,修改文档分析行为时需同步修改;assets/doc-template.go 用于新建带文档的包或导出 API;references/CONVENTIONS.md 用于参数、context、并发安全、清理、错误、命名返回值等约定;references/EXAMPLES.md 用于可运行示例;references/FORMATTING.md 用于 Godoc 列表、段落、链接和代码块格式。

适用场景:Go 项目文档编写与审查、导出 API 注释补全、Godoc 格式规范化、示例测试编写。

限制:资料未提供安装命令、收费、价格、平台或效果信息;行宽约 80 列为建议而非硬性限制;具体 lint 工具配置需参考相关技能。