Golang 推荐的命名规范

2024-04-04 23:01:03

很少见人总结一些命名规范，也可能是笔者孤陋寡闻，作为一个两年的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 推荐的命名规范相关推荐

Python之父Guido推荐的命名规范
如下: 总结一下: 1 只有全局常量或者类常量才全是大写 2 只有类名和异常名用驼峰法使名 3 除了全局常量.类常量.类名.异常名其它的命名规则都是小写字母加下划线 4 内部使用的情况下,当为prot ...
java bean 首字母大写_javaBean命名规范 get / set 后的首字母大写
javaBean命名规范 Sun 推荐的命名规范 1 ,类名要首字母大写,后面的单词首字母大写 2 ,方法名的第一个单词小写,后面的单词首字母大写 3 ,变量名的第一个单词小写,后面的单词首字母大写 ...
java set get大写_javaBean命名规范 get / set 后的首字母大写
javaBean命名规范 Sun 推荐的命名规范 1 ,类名要首字母大写,后面的单词首字母大写 2 ,方法名的第一个单词小写,后面的单词首字母大写 3 ,变量名的第一个单词小写,后面的单词首字母大写 ...
golang命名规范
命名规则 golang的变量函数命名需要使用驼峰命名法,且不能出现下划线, 文件名使用下划线 golang中根据首字母的大小写来确定可以访问的权限.无论是方法名.常量.变量名还是结构体的名称,如果首字 ...
web前端学习526-534（变量概述，变量的使用，变量语法扩展，变量命名规范，推荐Diagram Designer）
文章目录 1 变量概述 1.1 什么是变量 2 变量的使用 1 声明变量 2 赋值 3 变量的初始化案例:变量的使用 3 变量语法扩展 1 更新变量 2 同时声明多个变量 3 声明变量特殊情况 4 ...
Python之父Guido推荐命名规范
Python之父Guido推荐命名规范包括如下几点: 1.模块名和包名采用小写字母并且以下划线分隔单词的形式; 如:regex_syntax,py_compile,_winreg 2.类名或异常名采用 ...
初探Golang（2）-常量和命名规范
1 命名规范 1.1 Go是一门区分大小写的语言. 命名规则涉及变量.常量.全局函数.结构.接口.方法等的命名. Go语言从语法层面进行了以下限定:任何需要对外暴露的名字必须以大写字母开头,不需要对外 ...
html语言书写注意事项,CSS命名规范参考及书写注意事项
CSS书写顺序 *{ /*显示属性*/ display position float clear cursor - /*盒模型*/ margin padding width height /*排版*/ ...
Java 命名规范（非常全）
欢迎关注方志朋的博客,回复"666"获面试宝典在本文中,将从大到小,从外到内,总结Java编程中的命名规范.文中将会涉及到日常工作中常见的命名示例,如包命名,类命名,接口命名,方 ...

最新文章

热门文章