跨包的golang变量命名约定

Question

最近我开始学习 go-ethereum，这是我第一次使用 golang。 C++ 是我的主要语言，由于 go-ethereum 项目中的变量名，我有点困惑。

core/state/managed_state.go:25:type account struct {

core/state/state_object.go:98:type Account struct {

state包中同时存在“account”和“Account”两种类型，看起来很奇怪。

我检查了Naming convention for similar Golang variables，但它看起来仍然很糟糕。

我发现他们在不同的包中使用了很多“节点”结构。当然，它们确实有不同的目的和结构。

这些命名在 golang 中是约定俗成的吗？ 如果您对 golang 中的命名约定有任何好的参考（例如开源项目或书籍），您能说出其中的一些吗？将不胜感激。

Answer 1

state包中同时存在“account”和“Account”两种类型，看起来很奇怪。

在语言规范中这两个名称之间存在显着差异。

来自Go Language Specification：

可以导出一个标识符以允许另一个标识符访问它 包裹。如果两者都导出一个标识符：

1. 标识符名称的第一个字符是 Unicode 大写 字母（Unicode 类“Lu”）；和
2. 标识符在 包块或者它是一个字段名或方法名。

不导出所有其他标识符。

所以，仔细看看 go-ethereum 代码库，以下是我的观察：

• type account in managed_state.go 是一个内部实现细节，为the accounts field in the exported ManageState struct 提供一个类型
• type Account in state_object.go 是一个导出的标识符

当您查看 the generated documentation 时，我认为实现选择更有意义。

特别是Account type is front and center，详细说明了软件包消费者感兴趣的数据结构。

当您查看the documentation for the ManageState struct 时，故意未记录未导出的字段。这是因为它们是内部细节，不会影响导出的界面，并且可以轻松更改而不会影响包的用户。

---

关于命名建议，请参阅Names section in Effective Go。