[原创] Style Guide中文翻译（Google Protocol Buffers中文教程）

learnhard — Tue, 14 Sep 2010 05:30:16 +0000

Style Guide 风格指南

注：这是本人的翻译，可能不准确，可能有错误，但是基本上可以理解，希望能对大家有所帮助！（转载须注明出处：本文来自learnhard的博客：http://www.codelast.com/& http://blog.csdn.net/learnhard/）

This document provides a style guide for .proto files. By following these conventions, you'll make your protocol buffer message definitions and their corresponding classes consistent and easy to read.

本文档提供了.proto文件的书写风格指南。通过遵守这些约定，你的protocol buffer消息定义和它们的对应类将会风格一致且易于阅读。

Message And Field Names 消息和字段名

Use CamelCase (with an initial capital) for message names – for example, SongServerRequest. Use underscore_separated_names for field names – for example, song_name.

消息名使用驼峰格式（每个单词首字母大写）来书写——例如SongServerRequest。字段名使用小写的下划线分隔式（underscore_separated_names）来书写——例如song_name。

文章来源：http://www.codelast.com/

message SongServerRequest {

required string song_name = 1;

}

Using this naming convention for field names gives you accessors like the following:

字段名使用这种形式的命名约定的话，生成的访问类中的函数就有如下形式：

C++:
conststring& song_name(){...}
void set_song_name(conststring& x){...}

Java:
public String getSongName(){...}
public Builder setSongName(String v){...}

Enums 枚举

Use CamelCase (with an initial capital) for enum type names and CAPITALS_WITH_UNDERSCORES for value names:

枚举名使用驼峰格式（每个单词首字母大写）来书写，值名使用大写的下划线分隔式（CAPITALS_WITH_UNDERSCORES）来书写：

enum Foo {
FIRST_VALUE =1;
SECOND_VALUE =2;
}

Each enum value should end with a semicolon, not a comma.

每一个枚举值都应该以分号结尾，而不是逗号。

文章来源：http://www.codelast.com/

Services 服务

If your .proto defines an RPC service, you should use CamelCase (with an initial capital) for both the service name and any RPC method names:

如果你的.proto文件定义了一个RPC服务，那么服务名和任何RPC函数名都应该使用驼峰格式（每个单词首字母大写）来书写：

service FooService {

rpc GetSomething(FooRequest) returns (FooResponse);

}

文章来源：https://www.codelast.com/
➤➤ 版权声明 ➤➤
转载需注明出处：codelast.com
感谢关注我的微信公众号（微信扫一扫）：

Style Guide – 编码无悔 / Intent & Focused

[原创] Style Guide中文翻译（Google Protocol Buffers中文教程）

Style Guide 风格指南