golang命名规范

警告
本文最后更新于 2022-02-27 18:09,文中内容可能已过时。

包名称

包名称和所在的目录保持一致,包名应该是小写,不使用下划线或者混合大小写

1
package events

文件名

小写,使用下划线分割单词

1
configmap_manager.go

结构体

驼峰命名,大驼峰还是小驼峰取决于访问权限

1
2
3
type simpleConfigMapManager struct {
	kubeClient clientset.Interface
}

接口命名

同结构体,名字一般以er结尾

1
2
3
4
5
type Manager interface {
	GetConfigMap(namespace, name string) (*v1.ConfigMap, error)
	RegisterPod(pod *v1.Pod)
	UnregisterPod(pod *v1.Pod)
}

变量命名

同结构体,如果变量类型为 bool 类型,则名称应以 has, is, can 或 allow 开头。

1
2
3
4
var isExist bool
var hasConflict bool
var canManage bool
var allowGitHook bool

单元测试

文件名以_test.go结尾,测试用例中的函数以Test开头

1
2
3
4
// implicit_test.go
func TestImplicit(t *testing.T)  {

}
请我喝杯水
SoulChild 微信号 微信号
SoulChild 微信打赏 微信打赏
0%