Protocol buffers編寫風格指南

　　原文連接：https://developers.google.com/protocol-buffers/docs/style

Style Guide

　　本文說明了.proto文件的編寫風格指南。遵循這些約定，將使protocol buffer message的定義及其相應的類保持一致且易於閱讀。

Message And Field Names

　　對於message的命名，採用駝峯命名法（第一個字母大寫），例如SongServerRequest。對於message中的字段，採用下劃線分隔的方式命名，如song_name。

message SongServerRequest {
  required string song_name = 1;
}

　　使用這樣的命名規則能夠爲message中的字段提供get,set方法：

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

 

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

Enums

　　對於枚舉類型的命名採用駝峯命名法（CamelCase），枚舉類型中值的命名採用全大寫和下劃線（CAPITALS_WITH_UNDERSCORES）結合的命名。

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

　　每一個枚舉值應以分號結束，而不是逗號。

Services

　　若是.proto定義了RPC服務，對服務名和RPC方法使用駝峯命名法（CamelCase）：

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