メインコンテンツまでスキップ

protobuf style guides

ルール

requiredは使用しない

プロジェクトが進行するにつれて、フィールドはオプションになることがあります。しかし、requiredと定義されている場合は削除できません。

そのため、requiredは使用しないでください。

順序を変更しない

後方互換性を持たせるために、フィールドの順序は変更してはいけません。

命名規則

ファイル名

メッセージの名前はすべて小文字で、単語間にアンダースコアを使用します。 ファイルの拡張子は.protoで終わるようにしてください。

my_message.proto            // 良い
mymessage.proto // 悪い
my_message.pb // 悪い

メッセージ名

メッセージ名は大文字で始まり、新しい単語ごとに大文字を使用し、アンダースコアは使用せず、PBを接尾辞として付けます: MyMessagePB

message MyMessagePB       // 良い
message MyMessage // 悪い
message My_Message_PB // 悪い
message myMessagePB // 悪い

フィールド名

フィールドの名前はすべて小文字で、単語間にアンダースコアを使用します。

optional int64 my_field = 3;        // 良い
optional int64 myField = 3; // 悪い