Golang标识符关键字命名规则
标识符的组成
1.标识符由数字、字母和下划线(_)组成。例如123 abc _
2.只能以字母和下划线(_)开头。例如 abc123 _sysVar 123abc
3.标识符区分大小写。name Name NAME
1 | //正确的命名 |
go语言关键字
go语言提供了25个关键字,如下所示。
break | default | func | interface | select |
---|---|---|---|---|
case | defer | go | map | struct |
chan | else | goto | package | switch |
const | fallthrough | if | range | type |
continue | for | import | return | var |
除了以上的这些关键字,Go还有36个预定义标识符,其中包含了基本类型的名称和一些基本的内置函数,见下表:
append | bool | byte | cap | close | complex | complex64 | complex128 | uint16 |
---|---|---|---|---|---|---|---|---|
copy | false | float32 | float64 | imag | int | int8 | int16 | uint32 |
int32 | int64 | iota | len | make | new | nil | panic | uint64 |
println | real | recover | string | true | uint | uint8 | uintptr |
go语言命名规范
Go是一区分大小写的语言
命名规则涉及变量、常量、全局函数、结构、接口、方法等的命名。Go语言从语法层面进行了以下限定:任何需要对外暴露的名字必须以大写字母开头,不需要对外暴露的则应该以小写字母开头。
当命名(包括常量、变量、类型、函数名、结构字段等等)以一个大写字母开头,如:GetUserName,那么使用这种形式的标识符对象就可以被外部包的代码所使用(客户端程序需要先导入这个包),这被称为导出(像面向对象语言中的public),命名如果以小写字母开头,则对包外是不可见的,但是他们在整个包的内部是可见并且可用的(像面向对象语言中的private)
包名称
保持package的名字和目录保持一致,尽量采取有意义的包名,简短,有意义,尽量和标准库不要冲突。包名应该为小写单词,不要使用下划线或者混合大小写。
1 | package dao |
文件命名
尽量采取有意义的文件名,简短,有意义,应该为小写单词,使用下划线分割各个单词。
1 | customer_dao.go |
结构体命名
采用驼峰命名法,首字母根据访问控制大写或者小写
struct 声明和初始化格式采用多行,例如下面:
1 | type CustomerOrder struct { |
接口命名
命名规则基本和上面的结构体类似
单个函数的结构名以”er”作为后缀,例如Reader,Writer。
1 | type Reader interface { |
变量命名
和结构体类似,变量名称一般遵循驼峰法,首字母根据访问控制原则大写或者小写,但遇到特有名词时,需要遵循以下规则:
如果变量为私有,且特有名词为首个单词,则使用小写,如appService若变量类型为bool类型,则名称应以Has,Is,Can或Allow开头
1 | var isExist bool |
常量命名
常量均需使用全部大写字母组成,并使用下划线分词
1 | const APP_URL = "https://www.weiyunfeng.tk" |
如果枚举类型的常量,需要先创建相应类型:
1 | type Scheme string |
错误处理
错误处理的原则就是不能丢弃任何有返回err的屌用,不要使用 _ 丢弃,必须全部处理。接收到错误,要么返回err,或者使用log记录下来尽早return:一旦有错误发生,马上返回,尽量不要使用panic,除非你知道你在做什么,错误描述如果是英文必须为小写,不需要标点结尾,采用独立的错误流进行处理
1 | //错误写法 |
单元测试
单元测试文件名命名规范为 example_test.go 测试用例的函数名称必须以 Test 开头,例如:TestExample 每个重要的函数都要首先编写测试用例,测试用例和正规代码一起提交方便进行回归测试。