这是我参与「第五届青训营 」伴学笔记创作活动的第 13 天
一、本堂课重点内容：
- 高质量编程
二、详细知识点介绍：
- 高质量编程
1.2.3 编码规范——命名规范
variable
- 简洁胜于冗长
- 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
使用ServeHTTP而不是ServeHttp
使用XMLHTTPRequest或者xmlHTTPRequest - 变量距离其被使用的地方越远，则需要携带更多的上下文信息 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
例子1：
i和index的作用域范围仅限于for循环内部时，index的额外冗长几乎没有增加对于程序的理解。
例子2：
- 将deadline替换成t降低了变量名的信息量
- t常代指任意时间
- deadline指截止时间，有特定的含义。
function
- 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
- 函数名尽量简短
- 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
- 当名为foo的包某个函数返回类型T（T并不是Foo），可以在函数名中加入类型信息
例题：
因为该函数在http包中，所以我们倾向于使用第一种函数名中不带HTTP的方式。
package
- 只由小写字母组成，不包含大写字母和下划线等字符
- 简短并包含一定的上下文信息。例如schema、task等
- 不要与标准库同名。例如不要使用sync或者strings
以下规则尽量满足，以标准库包名为例
- 不使用常用变量名作为包名，例如标准库中使用bufio而不是buf
- 使用单数而不是复数，例如标准库中使用encoding而不是encodings
- 谨慎地使用缩写。例如使用fmt在不破坏上下文的情况下比format更加简短。
小结
- 核心目标是降低阅读理解代码的成本
- 重点考虑上下文信息，设计简洁清晰的名称
好的命名就像一个好笑话。如果你必须解释它，那就不好笑了。 ——Dave Cheney
三、引用参考：
