这是我参与「第三届青训营 -后端场」笔记创作活动的第2篇笔记。
高质量编程
简介
- 编写的代码能够达到正确可靠、简洁清晰、无性能隐患的目标就能称之为高质量代码
- 实际应用场景千变万化，各种语言的特性和语法各不相同，但是高质量编程遵循的原则是相通的
- 高质量的编程需要注意以下原则：简单性、可读性、生产力
常见编码规范
代码格式
- 使用 gofmt 自动格式化代码，保证所有的 Go 代码与官方推荐格式保持一致
代码注释
- 注释应该解释代码作用
-
适合注释公共符号
-
- 注释应该解释代码如何做的
- 适合注释实现过程
- 注释应该解释代码实现的原因
- 解释代码的外部因素
- 提供额外上下文
- 注释应该解释代码什么情况会出错
- 适合解释代码的限制条件
- 公共符号始终要注释
- 包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释
- 任何既不明显也不间断的公共功能必须予以注释
- 无论长度或复杂程序如何，对库中的任何函数都必须进行注释
总结
- 代码是最好的注释
- 注释应该提供代码未表达出的上下文信息
命名规范
variable
- 简洁胜于冗长
- 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
- 例如使用 SeverHTTP 而不是 ServerHttp
- 使用 XMLHTTPRequest 或者 xmlHTTPRequest
- 变量距离其被使用的地方越远，则需要携带越多的上下文信息
- 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
