SuperAPI AI 工具集

go-coding-standards

编程与开发

查看项目

更新于 10-15 21:37

技能介绍

用途:为编写或审查 Go 代码提供一套惯用规范,来源为 Effective Go、Go Code Review Comments 与生产实践。

主要能力:覆盖导入分组与排序(标准库、外部包、内部包,禁止点导入);包名、函数、变量、接口命名约定(如 getter 用 Name() 而非 GetName(),单方法接口用 -er 后缀,接口定义在使用方);顶层用 var、局部优先 :=;结构体初始化必须使用字段名;用提前返回减少嵌套;常量与变量分组及文件内函数排序;行长软限制 99 字符;defer 清理;枚举从 1 开始;用 time.Duration 与 time.Time;同一类型接收者种类保持一致;结构体标签需显式且格式正确,json:"-" 用于禁止序列化字段。

使用方式:作为编码与代码审查的检查清单使用。完成代码前需确保 goimports 无问题、go vet ./... 通过、golangci-lint run 通过(若已配置),并检查无遮蔽内置标识符、导入分组正确、结构体初始化使用字段名、无多余嵌套、接收者一致、序列化字段均有显式标签。

适用场景:Go 项目日常开发、代码评审、团队规范统一。

限制:资料未提供安装命令、平台支持、收费方式或具体工具集成步骤;部分规则为约定性建议,需结合项目实际配置执行。