简介

风格是指规范代码的共同约定。风格一词其实是有点用词不当的,因为共同约定的范畴远远不止 gofmt 所做的源代码格式化这些。

本指南旨在通过详尽描述 Uber 在编写 Go 代码中的注意事项(规定)来解释其中复杂之处。制定这些注意事项(规定)是为了提高代码可维护性同时也让工程师们高效的使用 Go 的特性。

这份指南最初由 Prashant Varanasi 和 Simon Newton 编写,目的是让一些同事快速上手 Go 。多年来,已经根据其他人的反馈不断修改。

这份文档记录了我们在 Uber 遵守的 Go 惯用准则。其中很多准则是 Go 的通用准则,其他方面依赖于外部资源:

  • Effective Go
  • The Go common mistakes guide所有的代码都应该通过 golintgo vet 检查。我们建议您设置编辑器:

  • 保存时自动运行 goimports

  • 自动运行 golintgo vet 来检查错误您可以在这找到关于编辑器设定 Go tools 的相关信息:

https://github.com/golang/go/wiki/IDEsAndTextEditorPlugins