运行时依赖
无特殊依赖
安装命令
点击复制官方npx clawhub@latest install golang-documentation
镜像加速npx clawhub@latest install golang-documentation --registry https://cn.longxiaskill.com
技能文档
概述
本技能提供了一个全面性的 Golang 项目文档指南，涵盖从 godoc 注释到 API 文档的所有方面，旨在帮助开发者维护高质量的项目文档。主要内容
- godoc 注释：如何编写有效的 godoc 注释
- README：撰写吸引人的 README 文件
- CONTRIBUTING：鼓励贡献的指南
- CHANGELOG：版本更新记录最佳实践
- Go Playground：在线测试和分享 Go 代码
- 示例测试：如何编写有效的示例测试
- API 文档：API 文档编写指南
使用指南
- 查看 godoc 注释编写指南
- 根据模板撰写 README、CONTRIBUTING 和 CHANGELOG
- 在 Go Playground 测试代码
- 编写并运行示例测试
- 按指南编写 API 文档
# 示例：如何生成 godoc
godoc -http=:6060
常见问题
- Q：如何确保文档始终更新？
- A：设定定期审查和更新流程