protobuf的最佳文件命名风格是什么?

时间:2012-12-13 14:04:53

标签: coding-style naming-conventions protocol-buffers naming

Style Guide有一个Protocol Buffers。但它没有明确说明如何命名.proto文件。

MyProtos.protomy_protos.protomy-protos.proto,这是更好的名字?

2 个答案:

答案 0 :(得分:5)

我不相信任何文件“应该被命名”的答案是正确的,而不是为了保持一致性和清晰度。

一致性意味着遵循项目已有的源和标头的文件命名约定。如果使用camel-case命名源,请对proto文件执行相同的操作。在我看来,最常见的选择是my_protos.proto版本。

对我来说清晰意味着文件名应该给出一些关于内容的线索。我通常喜欢在它们实现的类之后命名文件,并且通常每个类有一个单独的文件(对)。我会为proto文件推荐相同的内容。我更喜欢几个小原型文件,每个文件定义一个Message或非常密切相关的Messages,而不是一个巨大的原型文件,在一个地方定义所有Messages

答案 1 :(得分:0)

由于这个问题已经有将近8年的历史了,对于那些在2020年代看这个问题的人来说,现在有一个由Google发布的样式指南。

文件命名节选

文件应命名为lower_snake_case.proto

https://developers.google.com/protocol-buffers/docs/style