Golang 命名规范推荐的实现示例
更新时间：2026年04月14日 09:24:23 作者：winjeg
本文主要介绍了Golang 推荐命名规范的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
很少见人总结一些命名规范，也可能是笔者孤陋寡闻， 作为一个两年的golang 开发者， 我根据很多知名的项目，如 moby, kubernetess 等总结了一些常见的命名规范。 命名规范可以使得代码更容易与阅读， 更少的出现错误。
文件命名规范
由于文件跟包无任何关系， 而又避免windows大小写的问题，所以推荐的明明规范如下： 文件名应一律使用小写， 不同单词之间用下划线分割, 命名应尽可能地见名知意
常量命名规范
常量明明用 camelcase来命名示例如下
const todayNews = "Hello"
// 如果超过了一个常量应该用括号的方法来组织
const ( systemName = "What" sysVal = "dasdsada" )
变量命名规范
与常量命名方式一样，变量也应该使用驼峰的命名方式, 但注意尽量不与包名一致或者以包名开头
var x string x := new(string)
函数命名规范
由于Golang的特殊性（用大小写来控制函数的可见性），除特殊的性能测试与单元测试函数之外, 都应该遵循如下原则
- 使用驼峰命名
- 如果包外不需要访问请用小写开头的函数
- 如果需要暴露出去给包外访问需要使用大写开头的函数名称
一个典型的函数命名方法如下：
// 注释一律使用双斜线， 对象暴露的方法
func (*fileDao) AddFile(file *model.File) bool {
result := db.NewRecord(*file)
if result {
db.Create(file)
}
return result
}
// 不需要给包外访问的函数如下
func removeCommaAndQuote(content string) string {
re, _ := regexp.Compile("[\\`\\,]+")
return strings.TrimSpace(re.ReplaceAllString(content, ""))
}
接口命名规范
接口命名也是要遵循驼峰方式命名， 可以用 type alias 来定义大写开头的type 给包外访问
type helloWorld interface {
func Hello();
}
type SayHello helloWorld
Struct命名规范
与接口命名规范类似
receiver 命名规范
golang 中存在receiver 的概念 receiver 名称应该尽量保持一致， 避免this, super，等其他语言的一些语义关键字如下
type A struct{}
func (a *A) methodA() {
}
func (a *A) methodB() {
a.methodA()
}
注释规范
注释应一律使用双斜线
其他
格式化， 用tab不是空格， 可以与go fmt 兼容
到此这篇关于Golang 推荐命名规范的实现示例的文章就介绍到这了,更多相关Golang 命名规范内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
您可能感兴趣的文章:
相关文章
这篇文章主要介绍了在goland中配置gofmt的操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2020-12-12
这篇文章主要给大家讲解了Go语言的基础语法和常用特性解析，比较适合入门小白，文中通过代码示例介绍的非常详细，对我们学习Go语言有一定的帮助,需要的朋友可以参考下2023-07-07
本篇文章主要介绍了golang中的net/rpc包使用概述(小结)，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧2017-11-11
cobra既是一个用于创建强大现代CLI应用程序的库，也是一个生成应用程序和命令文件的程序。cobra被用在很多go语言的项目中，比如 Kubernetes、Docker、Istio、ETCD、Hugo、Github CLI等等2022-12-12
本文主要介绍了Go项目在GoLand中导入依赖标红问题解决,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧2024-08-08
这篇文章主要为大家详细介绍了基于Go语言实现一个简单的压测工具,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下2025-01-01
这篇文章主要介绍了Golang 1.16 中 Modules的主要变化更新,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2021-02-02
这篇文章主要介绍了Go基本数据类型与字符串相互转换，将string类型转换成基本类型时，必须确保string类型是有效的，文中补充介绍了Go基本数据类型和其字符串表示之间转换，结合实例代码给大家讲解的非常详细,需要的朋友可以参考下2024-01-01
这篇文章主要为大家介绍了goalng 结构体 方法集 接口实例详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪2022-09-09
下面小编就为大家带来一篇go1.8之安装配置具体步骤。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧2017-06-06
最新评论