README
约 1045 字大约 3 分钟
2025-09-04
uber-go/guide 的中文翻译
English
Uber Go 语言编码规范
Uber 是一家美国硅谷的科技公司，也是 Go 语言的早期 adopter。其开源了很多 golang 项目，诸如被 Gopher 圈熟知的 zap、jaeger 等。2018 年年末 Uber 将内部的 Go 风格规范 开源到 GitHub，经过一年的积累和更新，该规范已经初具规模，并受到广大 Gopher 的关注。本文是该规范的中文版本。本版本会根据原版实时更新。
版本
当前更新版本：2024-08-10 版本地址：commit:#227
如果您发现任何更新、问题或改进，请随时 fork 和 PR
Please feel free to fork and PR if you find any updates, issues or improvement.
介绍
样式 (style) 是支配我们代码的惯例。术语样式有点用词不当，因为这些约定涵盖的范围不限于由 gofmt 替我们处理的源文件格式。
本指南的目的是通过详细描述在 Uber 编写 Go 代码的注意事项来管理这种复杂性。这些规则的存在是为了使代码库易于管理，同时仍然允许工程师更有效地使用 Go 语言功能。
该指南最初由 Prashant Varanasi 和 Simon Newton 编写，目的是使一些同事能快速使用 Go。多年来，该指南已根据其他人的反馈进行了修改。
本文档记录了我们在 Uber 遵循的 Go 代码中的惯用约定。其中许多是 Go 的通用准则，而其他扩展准则依赖于下面外部的指南：
我们的目标是使代码示例能够准确地用于 Go 的两个发布版本 releases.
所有代码都应该通过golint和go vet的检查并无错误。我们建议您将编辑器设置为：
保存时运行
goimports运行
golint和go vet检查错误
您可以在以下 Go 编辑器工具支持页面中找到更为详细的信息：
https://go.dev/wiki/IDEsAndTextEditorPlugins