关于 Effective Go
Effective Go 是一项面向 Go 编码、审查和重构的技能,依据官方指南提供惯用写法建议,涵盖格式、错误处理、命名和并发。
主要功能
- 01惯用 Go 写法指导
- 02gofmt 格式规范
- 03命名与错误处理实践
- 04并发与接口建议
- 05文档编写规范
适用场景
- 01编写 Go 代码
- 02审查现有 Go 代码
- 03重构 Go 实现
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ openshift/ hypershift --skill effective-go安装后在 Claude Code 中输入/effective-go确认已加载。
详细介绍
Effective Go
应用官方 Effective Go 指南中的最佳实践和惯例,编写整洁、符合 Go 惯用风格的代码。
适用场景
在以下情况下自动使用此技能:
- 编写新的 Go 代码
- 审查 Go 代码
- 重构现有 Go 实现
关键提醒
遵循 https://go.dev/doc/effective_go 中记录的惯例和模式,尤其注意:
- 格式:始终使用
gofmt,这是不可妥协的要求 - 命名:不要使用下划线;导出名称使用 MixedCaps,未导出名称使用 mixedCaps
- 错误处理:始终检查错误;返回错误,不要触发 panic
- 并发:通过通信共享内存(使用通道)
- 接口:保持小巧(理想情况下包含 1~3 个方法);接受接口,返回具体类型
- 文档:为所有导出的符号编写文档,并以符号名称开头
参考资料
- 官方指南:https://go.dev/doc/effective_go
- 代码审查意见:https://github.com/golang/go/wiki/CodeReviewComments
- 标准库:可作为符合 Go 惯用风格的模式参考
评论
支持 Markdown