这是我参与「第五届青训营 」伴学笔记创作活动的第 5 天
高质量编程是什么
所谓高品质编程,不但结果高品质,而且过程也必须是高品质,具体来说指的是开发过程效率高、程序运行稳定可靠、性能高,代码简洁美观、易于维护。总而言之,可以把一切关于编程的美好的词汇都放在高品质编程上。
常见编码规范
包命名:package
保持package的名字和目录保持一致,尽量采取有意义的包名,简短,有意义,尽量和标准库不要冲突。包名应该为小写单词,不要使用下划线或者混合大小写。
文件命名
尽量采取有意义的文件名,简短,有意义,应该为小写单词,使用下划线分隔各个单词。
结构体命名
- 采用驼峰命名法,首字母根据访问控制大写或者小写
- struct申明和初始化格式采用多行
接口命名
- 命名规则基本和上面的结构体类型
- 单个函数的结构名以“er”作为后缀
常量命名
常量均需使用全部大写字母组成,并使用下划线分词
注释
包注释
一个位于package子句之前的块注释或行注释。
//util包,包含了一些工具
//创建人: yuleng
//创建时间: 20230209
结构(接口)注释
每个自定义的结构体都应该有注释说明,该注释对结构进行简要介绍,放在结构体定义的前一行,格式为 结构体名,结构体说明
// User,用户对象,定义了用户的基础信息
type User struct {
gorm.Model
UserName string `json:"user_name"` //用户名
Password string `json:"password"` //密码
FollowingCount int64 `json:"following_count"` //关注量
FollowerCount int64 `json:"follower_count"` //粉丝量
}
错误和异常处理
- 简单错误处理
- 错误的 Wrap 和 Unwrap
- 错误判定
- panic
- recover