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

一、编码规范

1.代码格式

gofmt——自动格式化Go语言代码。

goimports——等于gofmt加上依赖包管理，自动增删依赖的包引用、将依赖包按字母排序并分类。

2.注释

• 注释应该解释代码作用
  • 适合注释公共符号
• 注释应该解释代码如何做的
  • 适合注释实现过程
• 注释应该解释代码实现的原因
  • 适合解释代码的外部因素
  • 提供额外上下文
• 注释应该解释代码什么情况会出错
  • 适合解释代码的限制条件
• 公共符号始终要注释
  • 公共的符号：变量、常量、函数以及结构体
  • 不明显也不简短的公共功能
  • 库中的任何函数
  • 例外，不需要注释实现接口的方法

3.命名规范

variable

• 缩略词全大写，但当其位于变量开头且不需要导出时，全小写
  • 例如：ServeHTTP、XMLHTTPRequest或者xmlHTTPRequest
• 变量距离其被使用的地方越远，需要携带越多上下文信息
  • 例如：全局变量名字需要更多的上下文信息

function

• 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
• 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
• 当名为foo的包某个函数返回类型T时(T并不是Foo),可以在函数名中加入类型信息

package

• 只由小写字母组成。不包含大写字母和下划线等字符
• 简短并包含一定的上下文信息。例如 schema、task等
• 不要与标准库同名
• 不使用常用变量名作为包名。例如使用bufio而不是buf
• 使用单数而不是复数。例如使用encoding而不是encodings
• 谨慎地使用缩写，例如使用fmt在不破坏上下文的情况下比format更加简短