SuperAPI AI 工具集

go-naming

编程与开发

查看项目

更新于 10-15 20:30

技能介绍

用途:这是一个 Go 命名规范技能,在命名任何 Go 标识符时使用,帮助写出地道、清晰的名称。附带资源路由:scripts/check-naming.sh 用于检查命名反模式;references/ 下的 IDENTIFIERS.md、REPETITION.md、VARIABLES.md 分别用于首字母缩略词、重复命名、局部变量命名等场景。

核心原则:名称在使用时不应显得重复,需考虑上下文,不重复已明确的概念。Go 名称通常比其他语言更短。

主要规则:

  1. MixedCaps:所有标识符必须用 MixedCaps,仅测试函数、生成代码、系统/cgo 互操作可用下划线。
  2. 包名:小写、无下划线、简短单数名词,避免 util、common、helper 等泛化名称。
  3. 接口名:单方法接口用方法名加 -er 后缀(Reader、Writer),并遵循规范方法名。
  4. 接收者名:1-2 个字母的类型缩写,各方法保持一致,禁用 this 或 self。
  5. 常量名:MixedCaps,禁用 ALL_CAPS 或 K 前缀,按角色命名而非值(MaxRetries)。
  6. 首字母缩略词:大小写一致,如 HTTPClient、userID、ParseURL()。
  7. 函数与方法名:简单访问器不加 Get 前缀(Owner() 而非 GetOwner()),昂贵操作可用 Compute 或 Fetch。
  8. 变量名:长度与作用域成比例,小作用域用短名,避免名称中带类型,未导出全局变量可加 _ 前缀防遮蔽。
  9. 避免重复:按上下文精简,如 widget.New() 而非 widget.NewWidget()。
  10. 不得遮蔽 Go 预声明标识符(error、string、len、append 等)。

用法:重命名标识符后运行 bash scripts/check-naming.sh 验证,再运行 go build ./... 确认未破坏构建。

限制:该技能仅涉及命名规范,具体细节需参考相关技能(go-interfaces、go-packages、go-error-handling、go-declarations、go-style-core)。资料未提供安装方式、收费与平台信息。