Golang代码风格与命名规范应该怎样写

Go语言代码风格强调简洁清晰，通过gofmt统一格式，采用驼峰式命名，首字母大小写决定可见性，包名简短小写，接口多以er结尾，注释需完整规范，结构体字段导出则大写，整体注重一致性与可读性。

Go语言的代码风格与命名规范强调简洁、清晰和一致性。官方通过gofmt工具统一格式化代码，因此开发者无需手动调整缩进或括号位置。重点在于遵循社区广泛接受的约定，提升可读性和维护性。

使用驼峰式命名（CamelCase）

Go推荐使用驼峰式命名变量、函数和类型。首字母是否大写决定标识符的可见性：大写为公开，小写为包内私有。

• 公开类型或函数名首字母大写，如UserHandler、GetData
• 私有字段或局部变量首字母小写，如userName、parseRequest
• 避免使用下划线命名法（如user_name），除非是测试文件或特殊常量

包名应简短且全小写

包名应体现其功能，尽量使用单个简短名词，并全部小写，不包含下划线或连字符。

• 包名为util而不是utils或common_utils
• 包名与目录名一致，且避免使用复数形式
• 导出的函数名已能表达意图时，不必在包名中重复，例如io.Reader而非ior

注释要清晰并符合文档生成规范

每个导出的名称都应有注释说明其用途，注释以被描述对象开头，使用完整句子。

立即学习“go语言免费学习笔记（深入）”；

代码小浣熊

代码小浣熊是基于商汤大语言模型的软件智能研发助手，覆盖软件需求分析、架构设计、代码编写、软件测试等环节

51

查看详情

// User represents a person with name and email.
type User struct {
    Name  string
    Email string
}
<p>// SendNotification sends an email alert to the user.
func (u *User) SendNotification(msg string) error {
// ...
}

对于包级别的注释，应在package语句前用/* */或连续//注释说明整体功能。

结构体字段与接口命名简洁明确

结构体字段名应简洁但具描述性，接口名通常以er结尾（如Reader、Writer），除非上下文更清晰。

• 标准接口如http.Handler、io.Closer遵循动词+er模式
• 复合接口可使用组合名称，如ReadWriteCloser
• 结构体字段若导出，首字母大写；标签（tag）对齐可读性强

type Server struct {
    Addr     string `json:"addr"`
    Port     int    `json:"port"`
    Timeout  time.Duration `json:"timeout"`
}

基本上就这些。Go的风格重在一致性和可读性，借助gofmt和go vet工具自动检查大部分问题，团队协作时配合golint（或替代工具）进一步规范命名即可。

以上就是Golang代码风格与命名规范应该怎样写的详细内容，更多请关注php中文网其它相关文章！