命名规范
# 6. 命名规范
Go语言从语法层面进行了以下限定:
- ==任何需要对外暴露的名字必须以大写字母开头;==
- ==不需要对外暴露的则应该以小写字母开头。==
当命名(包括常量、变量、类型、函数名、结构字段等等)以一个大写字母开头,如:Analysize,那么使用这种形式的标识符的对象就可以被外部包的代码所使用(客户端程序需要先导入这个包),这被称为导出(像面向对象语言中的 public);
命名如果以小写字母开头,则对包外是不可见的,但是他们在整个包的内部是可见并且可用的(像面向对象语言中的 private )
# 6.1 包名称
保持package的名字和目录保持一致,尽量采取有意义的包名,简短,有意义,尽量和标准库不要冲突。包名应该为小写单词,不要使用下划线或者混合大小写。
# 6.2 文件命名
尽量采取有意义的文件名,简短,有意义,应该为小写单词,使用下划线分隔各个单词。
# 6.3 结构体命名
采用驼峰命名法,首字母根据访问控制大写或者小写,struct 申明和初始化格式采用多行,例如下面:
type MainConfig struct {
Port string `json:"port"`
Address string `json:"address"`
}
1
2
3
4
2
3
4
# 6.4 接口命名
接口命名命名规则基本和上面的结构体类型类似,单个函数的结构名以 “er” 作为后缀,例如 Reader ,Writer 。
- 命名以“er”结尾,如:Writer,xxxHandler,Helper,Manager等
- 接口方法声明 = 方法名+方法签名如:methodA (param1, param2)outputTypeList
type Reader interface {
Read(p []byte) (n int, err error)
}
1
2
3
2
3
# 6.5 变量命名
和结构体类似,变量名称一般遵循驼峰法,首字母根据访问控制原则大写或者小写,但遇到特有名词时,需要遵循以下规则:如果变量为私有,且特有名词为首个单词,则使用小写,如 appService若变量类型为 bool 类型,则名称应以 Has, Is, Can 或 Allow 开头。
var isExist bool
var hasConflict bool
var canManage bool
var allowGitHook bool
1
2
3
4
2
3
4
# 6.5 常量命名
常量均需使用全部大写字母组成,并使用下划线分词
const APP_URL = "https://www.baidu.com"
1
如果是枚举类型的常量,需要先创建相应类型:
type Scheme string const (
HTTP Scheme = "http"
HTTPS Scheme = "https"
)
1
2
3
4
2
3
4
上次更新: 2022/06/12, 15:48:09