码迷,mamicode.com
首页 > 其他好文 > 详细

Protocol buffers编写风格指南

时间:2019-01-14 00:23:10      阅读:226      评论:0      收藏:0      [点我收藏+]

标签:bsp   eve   void   方法   规则   ide   lan   文件   java   

  原文链接: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);
}

Protocol buffers编写风格指南

标签:bsp   eve   void   方法   规则   ide   lan   文件   java   

原文地址:https://www.cnblogs.com/Moon-Light-Dream/p/10264616.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!