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