翻譯查閱外網(wǎng)資料過(guò)程中遇到的比較優(yōu)秀的文章和資料缺亮,一是作為技術(shù)參考以便日后查閱,二是訓(xùn)練英文能力晚吞。
此文翻譯自 Protocol Buffers 官方文檔 Style Guide 部分
翻譯為意譯延旧,不會(huì)照本宣科的字字對(duì)照翻譯
以下為原文內(nèi)容翻譯
規(guī)范指引
本文為編寫(xiě) .proto 文件提供了一份規(guī)范指引。通過(guò)遵守這些規(guī)范約定载矿,你可以使你的 message 定義以及相關(guān)的類(lèi)保持一致性垄潮,同時(shí)也將更易于閱讀。
Message 和 字段命名
使用駝峰命名法(首字母大寫(xiě))命名 message闷盔,例子:SongServerRequest
使用下劃線命名字段弯洗,栗子:song_name
message SongServerRequest {
required string song_name = 1;
}
使用上述這種字段的命名約定,生成的訪問(wèn)器將類(lèi)似于如下代碼:
C++:
const string& song_name() { ... }
void set_song_name(const string& x) { ... }
Java:
public String getSongName() { ... }
public Builder setSongName(String v) { ... }
枚舉 Enums
使用駝峰命名法(首字母大寫(xiě))命名枚舉類(lèi)型逢勾,使用 “大寫(xiě)_下劃線_大寫(xiě)” 的方式命名枚舉值:
enum Foo {
FIRST_VALUE = 0;
SECOND_VALUE = 1;
}
每一個(gè)枚舉值以分號(hào)結(jié)尾牡整,而非逗號(hào)。
服務(wù) Services
如果你在 .proto 文件中定義 RPC 服務(wù)溺拱,你應(yīng)該使用駝峰命名法(首字母大寫(xiě))命名 RPC 服務(wù)以及其中的 RPC 方法:
service FooService {
rpc GetSomething(FooRequest) returns (FooResponse);
}
汪
汪