Uber Go 语言编程规范：包名称

最新推荐文章于 2024-03-25 10:06:01 发布
最新推荐文章于 2024-03-25 10:06:01 发布
阅读量107 收藏
点赞数
分类专栏： Uber技术研究
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/hero_java/article/details/114656179
版权

当命名包的时候，根据以下的规则来命名一个名称：

  • 全部小写。不要使用大写或下划线。
  • 大多数使用命名导入的情况下，不需要重命名。
  • 简短而简洁。请记住，在每个使用的地方都用全名标识。
  • 不要复数。例如，net/url, 而不要 net/urls.
  • 不要用"common", "util", "shared", 或者 "lib".这是不好的，因此此名称不提供充足信息的。

另外请参阅 Package Names 和 Style guideline for Go packages.

DreamCatcher
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
Uber公司Go 语言编码规范
06-14
2018年末，Uber将其内部的Go语言编码规范公开至GitHub，这份规范经过一年的发展和完善，已经成为广受Gopher欢迎的参考标准之一。 #### 指导原则 - **面向接口编程**：通常情况下，不建议使用指向接口类型的指针。...
Uber Go 语言编码规范中文版. The Uber Go Style Guide . .zip
最新发布
04-01
《Uber Go 语言编码规范中文版》是Uber公司为Go语言开发制定的一套详细编码标准，旨在提升代码质量、可读性和团队协作效率。这份规范不仅涵盖了基础的语法和编程习惯，还涉及到错误处理、并发编程、测试以及性能优化...
Uber Go 语言编程规范：函数名称
hero_java的专栏
03-11 60
我们遵循 Go 社区关于使用MixedCaps for function names的约定，有一个例外是针对测试函数，它可能包含下划线，用于分组相关的测试用例，例如：TestMyFunction_WhatIsBeingTested
Uber Go 语言编程规范：避免使用内置的名称
hero_java的专栏
03-09 108
Go语言的language specification中概括了几个内置的、predeclared identifiers（预声明的标识符），这些标识符不应该在Go程序中再次用作名称。 依赖于上下文，重新将这些标识符用做名称，将会遮盖原始标识符在当前的词法作用域(以及任何嵌套作用域)或者混淆代码，影响正常的代码逻辑。 最好的情况是，编译器将会报错。最坏的情况是，这样的代码可能会引起潜在的、难以捕捉的bug。 Bad var error string // `error` 覆盖了内建的error词..
Uber Go 语言编程规范：导入别名
hero_java的专栏
03-11 196
如果包名称不能与导入路径的最后一个元素匹配的话，则必须使用导入别名 import ( "net/http" client "example.com/client-go" trace "example.com/trace/v2" ) 在所有其他场景中，应该避免导入别名，除非导入之间有直接冲突 Bad import ( "fmt" "os" nettrace "golang.net/x/trace" //此处，应该避免使用导入别名 ) Good import (
Uber Go 语言编程规范：使用time处理时间
hero_java的专栏
03-07 176
时间处理是很复杂的。关于时间的错误的假设通常包括以下几个方面： 一天有 24 小时 一小时有 60 分钟 一周有七天 一年 365 天 还有更多 例如，1表示在一个时间点上加上24小时，并不总能产生一个新的日历日期。 因此， 在处理时间时，始终使用"time"包，因为它有助于以更安全、更精确的方式处理这些错误的假设。 使用time.Time表达瞬时时间 处理瞬时时间时请使用time.Time，在比较、添加和减少时间时使用time.Time中的方法。 Bad func isAct...
Uber Go 语言编程规范：命名Printf 样式的函数
hero_java的专栏
03-13 103
当声明一个printf样式的函数时，确保go vet工具能够检测到它并检查格式字符串。 这意味着，如果可能的话，您应该使用预定义的printf风格的函数名。go vet会默认进行检查。请查询Printf family得到更多的信息。 如果不能使用预定义的名称，则您选择的函数名称要以f 结尾：Wrapf, 而不是Wrap。go vet 可以检查特定的printf样式的名称，但它们必须以f结尾。 $ go vet -printfuncs=wrapf,statusf 另外，请参阅go vet: Pri.
值得参考的golang语言开发规范：Uber Go 语言编码规范，一些优秀的技巧可以提升代码的质量、避免代码缺陷和bug漏洞
代码讲故事
03-25 842
值得参考的golang语言开发规范：Uber Go 语言编码规范，一些优秀的技巧可以提升代码的质量、避免代码缺陷和bug漏洞。
Uber Go 语言编程规范：避免语义不明确的参数（Naked Parameters）
hero_java的专栏
03-12 111
函数调用中的意义不明确的参数（Naked parameters）可能会影响可读性，当参数名称的含义不明显时，请为参数添加 C 样式注释 (/* ... */) Bad // func printInfo(name string, isLocal, done bool) printInfo("foo", true, true) Good // func printInfo(name string, isLocal, done bool) printInfo("foo", true /* is.
Uber Go 语言编程规范：请在未导出的全局变量前加上_
hero_java的专栏
03-11 208
在未导出的顶层变量和常量前面加上_，以便在使用它们时清楚地表明它们是全局的标识符。 异常:未导出的错误值，应该以err作为前缀。 基本原理:顶层变量和常量有一个包的作用域。使用通用名称很容易在不同的文件中意外地使用错误的值。 Bad // foo.go //这两个常量拥有包级作用域 const ( defaultPort = 8080 defaultUser = "user" ) // bar.go func Bar() { //这个文件中，把默认端口给改掉了 defaultP
Uber Go 语言编码规范
J_Lee
12-04 1695
Uber Go 语言编码规范 中文版
The Uber Go Style Guide..zip
12-28
《Uber Go风格指南》是Uber公司为Go语言开发团队提供的一套编码规范和最佳实践，旨在提高代码质量、可读性和可维护性。遵循这套风格指南，开发者可以编写出更一致、更易于理解和协作的Go代码。以下是该风格指南中的...
Uber Go 语言编程规范：使用 go.uber.org/atomic
hero_java的专栏
03-09 1708
通过sync/atomic包的原子操作对原始类型s(int32,int64, etc.) 进行操作的时候，很容易忘记在对变量进行读取和修改的时候，使用原子操作。 而go.uber.org/atomic包通过隐藏基础类型对这些操作增加了类型安全，另外，它还包括了一个方便的atomic.Bool类型。 Bad type foo struct { running int32 // 原子类型 } func (f* foo) start() { //原子操作 if atomic.Swap..
Git 指定版本克隆
hero_java的专栏
04-18 1405
git clone -b v0.20.0 --depth=1 https://github.com/uber/cadence.git -b 后面写上指定 版本标签 , 即 tag, 比如 v0.20.0 --depth 表示克隆深度, 1 表示只克隆最新的版本. 如果项目迭代的版本很多, 克隆会很慢
Uber Go 语言编程规范：使用原生字符串字面值避免转义
hero_java的专栏
03-13 785
Go支持raw string literals（" ` " 来表示原生字符串）, 可以跨越多行并包含引号，使用这些可以避免手动转义的字符串，因为后者更难阅读。 Bad wantError := "unknown name:\"test\"" Good wantError := `unknown error:"test"` ...
Uber Go 语言编程规范：枚举从1开始
hero_java的专栏
03-06 655
在GO语言中引入枚举的标准方式是声明一个自定义类型和一个使用了iota的const组,由于变量有一个0的默认值，通常情况下，以非0值开始枚举。 Bad type Operation int const ( Add Operation = iota //从0开始 Subtract Multiply ) // Add=0, Subtract=1, Multiply=2 Good type Operation int const ( Add Operation = iota +
Uber Go 语言编程规范：避免调用init()方法
hero_java的专栏
03-09 617
尽可能的避免调用init()方法，当init()是不可避免或必需的时候，代码应该尝试做如下建议： 不管是程序的环境还是调用，必须是完全确定的。 避免依赖其他init()函数的调用顺序或副作用，虽然init()函数是顺序调用是众所周知的，但代码可能会发生变化，因此init()函数之间的关系可能会使代码变得脆弱且容易出错。 避免访问或操纵全局状态或环境状态，例如：服务器信息、环境变量、工作目录、程序参数/输入等。 避免I/O，包括文件系统、网络和系统调用。 不能满足这些需求的代码可能属于一个辅助函数，作
Uber Go 语言编程规范：import 分组顺序
hero_java的专栏
03-11 479
应该有两个导入组： 标准库 其他库 默认情况下，这是goimports设置的分组： Bad import ( "fmt" "os" "go.uber.org/atomic" "golang.org/x/sync/errgroup" ) Good import ( "fmt" "os" "go.uber.org/atomic" "golang.org/x/sync/errgroup" ) ...
Uber Go编程规范详解：提升代码可读性和效率
Uber的Go语言编程规范是一份详细的文档，旨在提供一套统一的编码标准和最佳实践，以提升代码的可读性、可维护性和开发效率。该规范基于Uber内部使用的编码风格，主要涵盖了以下几个核心部分： 1. **编程指南** - *...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

DreamCatcher

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值