文章目录
此文档为.proto
文件提供了样式指南。通过遵循这些约定,您将使您的协议缓冲区消息定义及其相应的类一致且易于阅读。
请注意,协议缓冲区样式是随着时间的推移而发展的,因此您可能会看到用不同约定或样式编写的.proto文件。修改这些文件时,Please respect the existing style
。Consistency is key.
。但是,在创建新的.proto
文件时,最好采用当前最好的样式。
Standard file formatting
- 保持行长为80个字符
- 使用两个空格的缩进
File structure
应将文件命名为lower_snake_case.proto
所有文件应以下列方式排序:
- 1.License header (if applicable)
- 2.File overview
- 3.Syntax
- 4.Package
- 5.Imports (sorted)
- 6.File options
- 7.Everything else
Packages
包名应该是小写的,并且应该对应于目录层次结构。例如,如果一个文件位于my/Package/
中,那么包名应该是my.Package
。