协议缓冲区有一个样式指南。但它没有明确说明文件应该如何命名。.proto
MyProtos.proto
,my_protos.proto
或者my-protos.proto
, 哪个名字更好听?
除了为了一致性和清晰性之外,我不认为任何文件“应该被命名”有一个合适的答案。
一致性意味着遵循您的项目已经对源和标头进行的文件命名约定。如果您的源使用驼峰式命名,请对 proto 文件执行相同操作。在我看来,最常见的选择是my_protos.proto
版本。
对我来说清晰意味着文件名应该提供一些关于内容的线索。我通常喜欢在它们实现的类之后命名文件,并且通常每个类都有一个单独的文件(对)。我会为 proto 文件推荐相同的方法。我更喜欢几个小的 proto 文件,每个文件定义一个Message
或非常密切相关Messages
的单个大型 proto 文件Messages
,在一个地方定义所有你的。
由于这个问题已经有将近 8 年的历史了,对于那些在 2020 年代看这个的人来说,现在有一个由 google 发布的风格指南。
文件命名摘录
文件应命名为 lower_snake_case.proto