这是我参与「第五届青训营 」伴学笔记创作活动的第 3 天
代码格式
- gofmt
Go语言官方提供的工具，能自动格式化Go语言代码为官方统一风格常见IDE都支持方便的配置 - goimports
也是Go语言官方提供的工具，实际等于gofmt加上依赖包管理，自动增删依赖的包引用、将依赖包按字母序排序并分类
注释
解释代码的作用 适合注释公共符号 解释代码如何做的 适合注释实现过程 解释代码实现的原因 适合解释代码的外部因素 提供额外上下文 解释代码什么情况会出错 适合解释代码的限制条件 公共符号始终要注释 包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释 任何既不明显也不简短的公共功能必须予以注释 无论长度或复杂程度如何，对库中的任何函数都必须进行注释 不需要注释实现接口的方法
命名规范
变量
简洁胜于冗长 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写 例如：使用ServeHTTP而不是ServeHttp 使用XMLHTTPRequest或者xmlHTTPRequest 变量距离其被使用的地方越远，则需要携带越多的上下文信息 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
函数
函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的 函数名尽量简短 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义 当名为foo的包某个函数返回类型T时(T并不是Foo)，可以在函数名中加入类型信息
package
只由小写字母组成，不包含大写字母和下划线等字符 简短并包含一定的上下文信息，例如：schema、task等 不要与标准库同名，例如不要使用sync或者strings 以下规则尽量满足，以标准库包名为例：
不使用常用变量名作为包名，例如使用bufio而不是buf 使用单数而不是复数，例如使用encoding而不是encodings 谨慎地使用缩写，例如使用fmt在不破坏上下文的情况下比format更加简短
控制流程
避免嵌套，保持正常流程清晰 尽量保持正常代码路径为最小缩进 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套 最常见的正常流程的路径被嵌套在两个if条件内 成功的退出条件是return nil,必须仔细匹配大括号来发现 函数最后一行返回一个错误，需要追溯到匹配的左括号，才能了解何时会触发错误 如果后续正常流程需要增加一步操作，调用新的函数，则又会增加一层嵌套
