编码规范
一、命名规范
- 命名以大写字母开头,使用这种标识符的对象可以被外部包的代码所使用,这被称为导出
- 命名如果以小写字母开头,则对外包是不可见的,但在整个包的内部是可见并且可用的
1.包命名:package
保持package的名字和目录保持一致,尽量采取有意义的包名,不要使用下划线
2.文件命名
应为小写单词,使用下划线分隔
3.结构体命名
- 采用驼峰命名法
- struct申明和初始化格式采用多行
type User struct{
Username string
Email string
}
4.接口命名
- 与结构体规则一致
- 单个函数的结构命名以“er”为后缀
5.变量命名
- 遵循驼峰命名法
- 若变量类型为bool类型,应当以Has,ls,Can或Allow开头
var isExist bool
var canManage bool
var hasConflict bool
6.常量命名
均需使用全部大写字母组成,并使用下划线分词
const APP_VER=“1.0”
如果是枚举类型,需要先创建相应的类型:
type Scheme string
const(
HTTP Scheme="http";
HTTPS Scheme="https"
7.关键字
注释
1.包注释
- 包的基本简介(包名,简介)
- 创建者,格式:创建人:rtx名
- 创建时间,格式:创建时间:yyyyMMdd 例如
util包,该包包含了项目共用的一些常量,封装了项目中一些共用函数
创建人:dfasfasd
创建时间:20210327