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);
}

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

时间: 2024-07-31 23:28:46

Protocol buffers编写风格指南的相关文章

Protocol Buffers(Protobuf)开发者指南---概览

Protocol Buffers(Protobuf)开发者指南---概览 欢迎来到protocol buffers的开发者指南文档,protocol buffers是一个与编程语言无关‘.系统平台无关.可扩展的结构化数据序列化/反序列化工具,适用于通讯协议,数据存储等场合. ps:为了方便拼写,下文的protobuf就是指protocol buffers. 本文档的面向读者是:希望使用protobuf的 Java.C++.Python的开发者.此概览将向您介绍如何开始使用protobuf,然后您

JavaScript编写风格指南

//参考<编写可维护的Javascript>  一:缩进// 第一行的层级由4个空格组成,避免使用制表符tab进行缩进 //好的写法if (true) {    doSomething();}  二:行的长度// 每行长度不应该超过80个字符.如果一行对于80个字符,应当在一个运算符(逗号,加号符)// 后换行.下一行应当增加两级缩进 //好的写法doSomething(argument1, argument2, argument3, argument4,    argument5);  三:

JavaScript编写风格指南 (三)

七(七):严格模式 // 严格模式应当仅限在函数内部使用,千万不要在全局使用 //不好的写法:全局使用严格模式"user strict"; function doSomething() {    //code} //好的写法function doSomething() {    "user strict"; //code} // 如果你期望在多个函数中使用严格模式而不需要多次声明"use strict", 可以使用立// 即被调用的函数 //好的

JavaScript编写风格指南 (二)

七:注释 // 频繁的使用注释有助于他人理解你的代码// 1.代码晦涩难懂// 2.可能被误认为是错误的代码// 3.必要但不明显的针对特定浏览器的代码// 4.对于对象,方法或者属性,生成文档是有必要的(使用恰当的文档注释) 七(一):单行注释 // 单行注释应当用来说明一行代码或者一组相关的代码.单行注释可能有三种使用方式// 1.独占一行的注释,用来解释下一行的代码// 2.在代码行的尾部的注释,用来解释它之前的代码// 3.多行,用来注释掉一个代码块 Example: //好的写法if

Protocol Buffers 语法指南

前两篇文章,我们概括介绍<Google Protocol Buffers 概述>以及带领大家简单的<Google Protocol Buffers 入门>,接下来,再稍微详细一点介绍Protocol Buffers书写语言.该篇文章主要讲解如何使用PB语言构建数据,包括.proto文件语法及如果使用.proto文件生成数据存取类. 本篇主要包括: 定义一个PB message类型 介绍PB 数据类型 Optional字段及其默认值 枚举类型 使用其他Message类型作为filed

Protocol Buffers官方文档(proto3语言指南)

本文是对官方文档的翻译,大部分内容都是引用其他一些作者的优质翻译使文章内容更加通俗易懂(自己是直译,读起来有点绕口难理解,本人英文水平有限),参考的文章链接在文章末尾 这篇指南描述如何使用protocol buffer语言来组织你的protocol buffer数据,包括.proto文件的语法规则以及如何通过.proto文件来生成数据访问类代码. Defining A Message Type(定义一个消息类型) syntax = "proto3"; message SearchReq

Protocol Buffers(Protobuf) 官方文档--Protobuf语言指南

Protocol Buffers(Protobuf) 官方文档--Protobuf语言指南 约定:为方便书写,ProtocolBuffers在下文中将已Protobuf代替. 本指南将向您描述如何使用protobuf定义i结构化Protobuf数据,包括.proto文件语法和如何使用.proto文件生成数据存取类. 作为一个参考指南,本文档将以示例的形式一步步向您介绍Protobuf的特点.您可以参考您所选择的语言的示例.tutorial ----------------------------

Protocol Buffers官方文档(开发指南)

本文是对官方文档的翻译,然后截取了一篇非常优秀的文章片段来帮助理解,本人英文水平有限,基本都是直译,如果有不理解的地方请参考英文官方文档,参考的文章链接在文章末尾 protocol buffers简介 protocol buffer是google的一个开源项目,它是用于结构化数据串行化的灵活.高效.自动的方法,例如XML,不过它比xml更小.更快.也更简单.你可以定义自己的数据结构,然后使用代码生成器生成的代码来读写这个数据结构.你甚至可以在无需重新部署程序的情况下更新数据结构 protocol

Google Protocol Buffers 入门

1. 前言 这篇入门教程是基于Java语言的,这篇文章我们将会: 创建一个.proto文件,在其内定义一些PB message 使用PB编译器 使用PB Java API 读写数据 这篇文章仅是入门手册,如果想深入学习及了解,可以参看: Protocol Buffer Language Guide, Java API Reference, Java Generated Code Guide, 以及Encoding Reference. 2. 为什么使用Protocol Buffers 接下来用“