详解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 兼容

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

关于golang类型推断和变量重声明详解
在Go语言中,类型推断可以根据变量的初始化值自动推断出变量的类型,而不需要显式地声明变量类型,变量重声明可以在同一作用域内重复声明一个变量,只要其中至少一个是新的变量,本就简单的给大家介绍一下golang类型推断和变量重声明,需要的朋友可以参考下
2023-08-08
go按行读取文件的三种实现方式汇总
最近有遇到需要用go读取文件的情况,下面这篇文章主要给大家介绍了关于go按行读取文件的三种实现方式,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
2022-09-09
基于go中fyne gui的通达信数据导出工具详解
这篇文章主要介绍了基于go中fyne gui的通达信数据导出工具,这是一个用 Go 语言开发的通达信数据导出工具,可以将通达信的本地数据导出为多种格式,方便用户进行数据分析和处理,需要的朋友可以参考下
2024-12-12
Go语言错误处理异常捕获+异常抛出
这篇文章主要介绍了Go语言错误处理异常捕获和异常抛出，Go语言的作者认为java等语言的错误处理底层实现较为复杂,就实现了函数可以返回错误类型以及简单的异常捕获,虽然简单但是也非常精妙,大大的提高了运行效率,下文需要的朋友可以参考一下
2022-02-02
深入理解GO语言的面向对象
相信很多人当初开发go语言的时候就是因为C++的特性太过于繁杂，从而使得很多C++的开发者因为C++的特性而头疼，go语言成功的精简了C++的特性，使其很简洁，很少的特性，却可以完成很多的事情。下面我们就来详细理解下GO语言的面向对象。
2016-10-10
详解Go语言中的结构体的特性
结构体是Go语言中重要且灵活的概念之一，本文旨在深入介绍Go语言中的结构体，揭示其重要性和灵活性，并向读者展示结构体支持的众多特性，需要的可以参考一下
2023-06-06
go mod更新指定的tag的包后,go vendor内容未更新问题
这篇文章主要介绍了go mod更新指定的tag的包后,go vendor内容未更新问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2023-09-09
Mac下Vs code配置Go语言环境的详细过程
这篇文章给大家介绍Mac下Vs code配置Go语言环境的详细过程，本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友参考下吧
2021-07-07
一文带你熟悉Go语言中函数的使用
这篇文章主要和大家分享一下Go语言中的函数的使用，文中的示例代码讲解详细，对我们学习Go语言有一定的帮助，需要的小伙伴可以参考一下
2022-11-11
详解Go语言如何对数据库进行CRUD操作
在这篇文章中，主要带大家来学习一下在Go语言中如何对数据库进行CRUD操作，从而探讨一下Go的接口编程，感兴趣的小伙伴可以跟随小编一起学习一下
2023-05-05

详解Golang 推荐的命名规范

相关文章

最新评论

大家感兴趣的内容

最近更新的内容

常用在线小工具