概览

原文：https://google.github.io/styleguide/go

关于

本系列的 Go 风格指南和相关文档整理了当前，最佳的一个编写易读和惯用方式的 Go 写法。遵守风格指南并不是绝对的，这份文件也永远不会详尽无遗。我们的目的是尽量减少编写可读 Go 代码的猜测，以便该语言的新手可以避免常见的错误。此风格指南也用于统一 Google 内 Go 代码 review 者的风格指南。

文档	链接	主要受众	视为标准(Normative)	视为规范(Canonical)
风格指南	https://gocn.github.io/styleguide/docs/02-guide/	所有人	Yes	Yes
风格决策	https://gocn.github.io/styleguide/docs/03-decisions/	可读性导师	Yes	No
最佳实践	https://gocn.github.io/styleguide/docs/04-best-practices/	任何有兴趣的人	No	No

文档说明

风格指南(Style Guide) (https://gocn.github.io/styleguide/docs/02-guide/) 概述了 Google Go 风格的基础。本文档为定义名词性质的文件，用作风格决策和最佳实践中建议的基础。
风格决策(Style Decisions) (https://gocn.github.io/styleguide/docs/03-decisions/) 是一份更详细的文档，它总结了特定场景下风格的决策理由，并在适当的时候讨论了决策背后的原因。

这些决定可能偶尔会根据新数据、新语言特性、新代码库或新出现的模式而改变，但不期望 Google 的 Go 程序员能及时了解本文档的更新。
最佳实践(Best Practices) (https://gocn.github.io/styleguide/docs/04-best-practices/) 描述了一些随时间演变的模式，这些模式可以解决通用问题，可读性强，并且对代码可维护的需要有很好的健壮性。

这些最佳实践并不规范，但鼓励 Google 的 Go 程序员尽可能使用它们，以保持代码库的统一和一致。

这些文件旨在:

就权衡备选风格的一套原则达成一致
整理最终的 Go 编码风格
记录并提供 Go 编码惯用法的典型示例
记录各种风格决策的利弊
帮助减少在 Go 可读性 review 时的意外
帮助可读性导师使用一致的术语和指导

本文档无意于：

成为在可读性审查时的详尽的意见清单
列出所有的规则，期望每个人在任何时候都能记住并遵守
在语言特型和风格的使用上取代良好的判断力
为了消除风格差异，证明大规模的改变是合理的

不同 Go 程序员之间以及不同团队的代码库之间总会存在差异。然而，我们的代码库尽可能保持一致符合 Google 和 Alphabet 的最大利益。（有关一致性的更多信息，请参阅指南。）为此，您可以随意进行风格改进，但不需要挑剔你发现的每一个违反风格指南的行为。特别是，这些文档可能会随着时间的推移而改变，这不是导致现有代码库做出额外改动的理由；使用最新的最佳实践编写新代码，并随着时间的推移解决上下文或者关联到的代码的问题就足够了。

重要的是要认识到风格问题本质上是个人的，并且总是带有特定的权衡。这些文档中的大部分指南都是主观的，但就像 gofmt 一样，它提供的一致性具有重要价值。因此，风格建议不会在未经适当讨论的情况下改变，Google 的 Go 程序员被鼓励遵循风格指南，即使他们可能不同意。

定义

风格文档中使用的以下词语定义如下：

规范(Canonical)
制定规定性和持久性规则

在这些文档中，“规范”用于描述被认为是所有代码（旧的和新的）都应该遵循的标准，并且预计不会随着时间的推移而发生重大变化。规范文档中的原则应该被作者和审稿人理解，因此规范文档中包含的所有内容都必须达到高标准。如此一来，与非规范文档相比，规范文档通常更短并且规定的风格元素更少。
标准(Normative)
旨在建立一致性

在这些文档中，“规范”用于描述 Go 代码审查者使用的一致同意的风格元素，以便建议、术语和理由保持一致。这些元素可能会随着时间的推移而发生变化，本文涉及的这些文件将反映出这些变化，以便审阅者可以保持一致和及时更新。 Go 代码编写者不被要求熟悉此文档，但这些文档将经常被审阅者用作可读性审查的参考。
惯用写法(Idiomatic)
常见且熟悉

在这些文档中，“惯用写法”指在 Go 代码中普遍存在的东西，并已成为一种易于识别的常见写法。一般来说，如果两者在上下文中服务于相同的目的，那么惯用写法应该优先于非惯用写法，因为这将是读者最熟悉的写法。

附加参考

本指南假定读者熟悉 Effective Go，因为它为整个 Go 社区的 Go 代码提供了一个通用基线。

下面是一些额外的资源，供那些希望自学 Go 风格的人和希望在他们的评审中附上可链接的评审依据的代码审阅者。不期望Go 可读性过程的参与者熟悉这些资源，但它们可能作为可读性审阅的相关依据出现。

外部参考

马桶测试(Testing-on-the-Toilet) 相关文档

厕所里的测试（又称 TotT）是测试小组最明显的成就。从2006年开始，TotT 从一个会议上的玩笑开始，已经成为一个真正的谷歌机构，并且是在公司内部传播想法、产生讨论和推动新的内部工具采用的最有效的方式之一。TotT

额外的外部文档

{{< button relref=”/“ >}}首页{{< /button >}} {{< button relref=”./02-guide.md” >}}下一章{{< /button >}}

概览

概览

关于

文档说明

定义

规范(Canonical)

标准(Normative)

惯用写法(Idiomatic)

附加参考