这是我参与「第五届青训营 」伴学笔记创作活动的第 5 天
高质量编程
如何写出更简洁清晰的代码，在工作中，编程式团队合作的工程，好的代码让其他人更容易在你的基础上开发，同时出问题的概率更低，大家更乐于与你工作，也让团队更高效，另外在面试的时候，也有编码环节，能不能用代码清晰的表达出你的思路，让面试官额外加分。
代码格式
首先是推荐使用gofmt自动格式化代码，保证所有的Go代码与官方推荐格式保持一致，而且可以很方便的进行配置，像Goland内置了相关功能，直接开启即可在保存文件的时候自动格式化。另外可以考虑goimports，会对依赖包进行管理，自动增删依赖的包引用，按字母序排序分类。具体可以根据团队实际情况配置使用。
这足以将格式化放在第一条，因为这是后续规范的基础。团队合作review其他人的代码时就能体会到这条规范的作用。
注释
首先是注释应该解释代码作用，这种注释是说明公共符号，比如对外提供的函数注释描述它的功能和用途，只有在函数的功能简单而明显时才能省略这些注释，比如简单的取值和设值函数。另外注释要避免啰嗦，不要对显而易见的内容进行说明。
第二种注释是对代码中复杂的，并不明显的逻辑进行说明，适合注释实现过程。
第三种，注释可以解释代码的外部因素，这些因素脱离上下文后通常难以理解。
第四，注释应该提醒使用者一些潜在的限制条件或者会无法处理的情况。比如函数的注释中可以说明是否存在性能隐患，输入的限制条件，可能存在哪些错误情况，让使用者无需了解实现细节。
然后比较大的一方面是公共符号的注释。GoogleStyle指南中有两条规则，任何即不明显也不简短的公共功能必须予以注释，无论长度或复杂程度如何，对库中的任何函数都必须予以注释。
