翻譯查閱外網資料過程中遇到的比較優秀的文章和資料,一是作為技術參考以便日后查閱,二是訓練英文能力。
此文翻譯自 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);
}
汪
汪