Go Documentation · 从源码事实整理用途、约束与可执行示例

@public/golang-documentation

查看空间 →

按 Go 库或应用的不同读者需求,整理包注释、导出 API 说明、入门文档、配置帮助与示例。强调解释适用场景、约束和错误行为,保持编辑前后的含义与义务一致,不编造实现理由或效果。采用 MIT 许可证。

能力与使用条件

适用场景

  • 核对 Go API 注释与真实代码是否一致
  • 补充库示例或应用安装与配置说明
  • 审查项目说明中的缺漏、夸大与过时信息

输入要求

  • Go 源码、既有文档与目标读者
  • 已验证的安装、配置、错误行为和公开范围

输出结果

  • 有源码依据的文档补充或修订
  • 示例与实际验证记录、仍待确认的说明

前置条件

  • 读取真实代码与项目文档约定,区分库、应用及对外接口
  • 示例需要验证时在项目容器中运行;公开托管或上传内容前确认授权和数据范围

不适用场景与限制

  • README 结构、注释模板和 llms.txt 是指南建议,不要求所有项目照搬,也不覆盖项目产物格式约定
  • 示例 Playground 链接和下载命令可能是占位,必须实际验证后才作为可用链接交付
  • 私有项目内容不自动提交第三方索引、公开 Playground 或文档站;文档完善不代表代码已实现或测试已通过
  • 下载链接为固定提交的完整仓库快照,使用其中 skills/golang-documentation 目录。配图是说明性示例。

说明性示例

  • 核对这个 Go 包的导出 API 与文档,补充用途、错误和并发约束,删除没有源码依据的宣传语;示例运行后报告结果,不上传私有代码。

资料依据

  • https://github.com/samber/cc-skills-golang/blob/d68d80aec298e1b74b37c2a472c002b5217248b3/skills/golang-documentation/SKILL.md
  • https://github.com/samber/cc-skills-golang/blob/d68d80aec298e1b74b37c2a472c002b5217248b3/LICENSE

外部资源

内容由外部网站提供,平台不保证第三方文件的完整性、可用性或安全性。

外部文件的访问权限由第三方管理,本站无法限制其地址的访问。