美文网首页Protobuf
[翻译] ProtoBuf 官方文档(四)- 规范指引

[翻译] ProtoBuf 官方文档(四)- 规范指引

作者: 401 | 来源:发表于2018-07-29 18:54 被阅读0次

翻译查阅外网资料过程中遇到的比较优秀的文章和资料,一是作为技术参考以便日后查阅,二是训练英文能力。

此文翻译自 Protocol Buffers 官方文档 Style Guide 部分

翻译为意译,不会照本宣科的字字对照翻译
以下为原文内容翻译

规范指引

本文为编写 .proto 文件提供了一份规范指引。通过遵守这些规范约定,你可以使你的 message 定义以及相关的类保持一致性,同时也将更易于阅读。

Message 和 字段命名

使用驼峰命名法(首字母大写)命名 message,例子:SongServerRequest
使用下划线命名字段,栗子:song_name

message SongServerRequest {
  required string song_name = 1;
}

使用上述这种字段的命名约定,生成的访问器将类似于如下代码:

C++:
  const string& song_name() { ... }
  void set_song_name(const string& x) { ... }

Java:
  public String getSongName() { ... }
  public Builder setSongName(String v) { ... }

枚举 Enums

使用驼峰命名法(首字母大写)命名枚举类型,使用 “大写_下划线_大写” 的方式命名枚举值:

enum Foo {
  FIRST_VALUE = 0;
  SECOND_VALUE = 1;
}

每一个枚举值以分号结尾,而非逗号。

服务 Services

如果你在 .proto 文件中定义 RPC 服务,你应该使用驼峰命名法(首字母大写)命名 RPC 服务以及其中的 RPC 方法:

service FooService {
  rpc GetSomething(FooRequest) returns (FooResponse);
}

相关文章

网友评论

    本文标题:[翻译] ProtoBuf 官方文档(四)- 规范指引

    本文链接:https://www.haomeiwen.com/subject/wiltvftx.html