Protocol Buffers Style Guide

风格指南

本文档提供了.proto文件的样式指南。通过遵循这些约定，您将使protocol buffer消息定义及其对应的类一致且易于阅读。

消息和字段名称

使用大驼峰格式（CamelCase）作为消息名称 - 例如，SongServerRequest。
对于字段名称使用下划线分割的小写单词命名（underscore_separated_names），例如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) { ... }

枚举

使用大驼峰格式（CamelCase）作为枚举类型名称，使用下划线分割的大写单词（CAPITALS_WITH_UNDERSCORES）作为值名称：

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

每个枚举值应以分号结尾，而不是逗号。

服务

如果您的.proto定义了RPC服务，那么您应该使用大驼峰格式（CamelCase）作为服务名称和任何RPC方法名称：

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

参考链接: Style Guide & Third-Party Add-ons