这是我参与「第五届青训营」伴学笔记创作活动的第 13 天

概述

通过上一届我们已经学会了如何写注释，现在让我们来看看实际写代码中的规范。写代码最常见的就是命名，不管是变量命名还是函数命名都希望能够清晰简洁。

命名规范

1.简洁胜过冗长。

2.缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写。例如使用ServeHTTP而不是ServeHttp.

3.变量距离被使用的地方越远，则需要携带越多的上下文信息。全局变量在其名字中需要更多的上下文信息，使得在不同的地方可以轻易辨认出其含义。

变量的作用范围仅限于for循环内部时，变量命名的额外冗长几乎没有增加对于程序的理解，就应该简短变量名。

1.函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的。

2.函数名尽量简短。

3.当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义。当名为foo的包某个函数返回类型T时，可以在函数名中加入类型信息。

1.只由小写字母组成，不包含大写字母和下划线等字符。

2.简短并包含一定的上下文信息。例如schema和task等。

3.不要与标准库同名。例如并不使用sync或者strings。

4.不使用常用变量名作为包名。例如使用bufio而不是buf。

5.使用单数而不是复数。例如使用encoding而不是encodings

6.谨慎的使用缩写，例如使用fmt在不破坏上下文的情况下比format更加简短。

总结：核心目标是降低阅读理解代码的成本。重点考虑上下文信息，设计简洁清晰的名称。