【Google Protocol Buffer】Style Guide中文翻译

客官°小女子只卖身不卖艺 2022-09-30 07:11 176阅读 0赞

# **Style Guide****风格指南** #

注：这是本人的翻译，可能不准确，可能有错误，但是基本上可以理解，希望能对大家有所帮助！（转载请注明出处：本文来自learnhard的博客：[http://www.codelast.com/][http_www.codelast.com]& [http://blog.csdn.net/learnhard/][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**。**

（转载请注明出处：本文来自learnhard的博客：[http://www.codelast.com/][http_www.codelast.com]& [http://blog.csdn.net/learnhard/][http_blog.csdn.net_learnhard]）

message SongServerRequest \{

required string song\_name = 1;

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

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

C\++:  
 conststring&song\_name()\{ …\}  
 voidset\_song\_name(conststring&x)\{ …\}

Java:  
 publicString getSongName()\{ …\}  
 publicBuilder setSongName(String v)\{ …\}

**Enums****枚举**

Use CamelCase (with an initial capital) for enum type names and CAPITALS\_WITH\_UNDERSCORES for value names:

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

enumFoo\{   
 FIRST\_VALUE=1;  
 SECOND\_VALUE=2;  
\}