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

概述

了解上节内容后，具体的实践中有哪些经验能帮助我们编写高质量的代码？接下来介绍go原因呢的编码规范。Google官方和大规模采用go的公司，都有开源的编码规范文档，这里从中选择比较重要的公共约定的部分进行介绍。

代码格式

gofmt：go语言官方提供的工具，能自动格式化go语言代码为官方统一风格，常见的IDE都支持方便的配置。

goimports：也是go语言官方提供的工具，实际等于gofmt加上依赖包管理，自动增删依赖包引用、将依赖的包按照字母排序并分类。

适用于公共符号，比如对外提供的函数注释描述它的功能和用途，只有在函数的功能简单而明显时才能省略这些注释。另外注释应该避免啰嗦。通过名称就很很容易知道名称的函数就不必加上注释了。

对并不明显的逻辑进行说明，适合注释实现过程。但请注意不要用自然语言直接翻译代码作为注释，有时候表述不一定和代码一致。

注释可以解释代码的外部原因，这些因素脱离上下文后通常很难理解。

注释应该提醒使用者一些潜在的限制条件或者会无法处理的情况。

任何既不明显也不简短的公共功能必须予以注释

无论长度或复杂程度如何，对库中的任何函数都必须进行注释。