详解Golang 推荐的命名规范
更新时间：2019年02月20日 14:52:59 作者：winjeg
这篇文章主要介绍了详解Golang 推荐的命名规范，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
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 兼容
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。
您可能感兴趣的文章:
相关文章
本文主要介绍了Go语言中WaitGroup并发同步的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧2026-04-04
这篇文章主要为大家详细介绍了Go语言标准库math和rand中的常用函数，文中的示例代码讲解详细， 对我们学习Go语言有一定的帮助，感兴趣的小伙伴可以了解一下2022-12-12
在Go语言的并发编程中,如何确保多个goroutine安全地访问共享资源是一个关键问题,Go语言提供了sync包,其中包含了多种同步原语,用于解决并发编程中的同步问题,本文将详细介绍sync包中的锁机制,需要的朋友可以参考下2024-10-10
这篇文章主要介绍了线上golang grpc服务资源泄露问题排查,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教2023-12-12
GORM 是一个流行的开源 ORM (Object-Relational Mapping) 库,专为 Go 语言设计,它简化了与 SQL 数据库的交互,GORM 封装了数据库操作,使得开发者能够通过简单的链式调用来执行 CRUD,本文给大家介绍了Golang Gorm实现自定义多态模型关联查询,需要的朋友可以参考下2024-11-11
在Go实际开发中,并发安全是老生常谈的事情,在并发下,goroutine之间的存在数据资源等方面的竞争,为了保证数据一致性、防止死锁等问题的出现,在并发中需要使用一些方式来实现并发控制,本文给大家总结了几种实现方式,需要的朋友可以参考下2023-12-12
缓存在项目中使用应该是非常频繁的,提到缓存只要了解过 singleflight ,基本都会用于缓存实现的一部分吧,下面就跟随小编一起来学习一下singleflight的使用吧2024-02-02
下面小编就为大家分享一篇golang实现并发数控制的方法，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2017-12-12
简洁的代码对于创建可维护、可阅读和高效的软件至关重要,Go 是一种强调简单和代码整洁的语言,在本文中,我们将结合代码示例,探讨编写简洁 Go 代码的最佳实践,需要的朋友可以参考下2023-09-09
对于线上稳定运行的服务来说, 可能会遇到 cpu、mem 利用率升高的问题，那我们就需要使用 pprof 工具来进行性能分析，所以本文就来和大家讲讲pprof的具体使用吧2023-05-05
最新评论