ChatGPT Go API 文档技能:按 godoc 写公开接口契约
EnglishChatGPT 安装步骤
- 打开固定提交的 .agents/skills/document-go-apis/SKILL.md,核对原文的输入和输出。
- 在 ChatGPT 打开「插件 → 技能 → 创建 → 使用编辑器创建」。
- 按下面的工作流程填写技能规则。提供公共标识符、签名、行为约束、版本和已核实的示例。
- 保存技能,在新对话输入本页的虚构示例并核对结果。
中文摘要
把已确认的公开 Go 类型、函数和方法行为写成可读注释。保留标识符、参数单位、零值、错误条件和并发约束。
SKILL.md 中文导读
可复现示例
虚构 `WaitForTask` 接受 context 和秒数参数,取消时返回 `context.Canceled`。作者未说明是否线程安全。请拟函数注释与待补条件。工作步骤
- 定位公开函数、类型或包。
- 以标识符开头写调用方契约。
- 核对单位、错误、阻塞、并发和示例。
验收方法
注释以函数名开头,写清阻塞、秒单位和取消条件。并发安全列为待核,不添加无依据承诺。
GitHub 原文 · 更新日期
适用环境
需要启用了技能创建的 ChatGPT 工作区。这里使用基于 GitHub 原文编写的文本改编。
常见问题
函数签名能说明零值或错误语义吗?
签名给类型和返回形式。零值、可分支错误及并发行为要从已确认实现、测试或维护者说明补证。