ProtoBuf Style Guide(中文版)

这份文档提供了协议缓冲区消息定义的样式指南,旨在确保文件的一致性和易读性。建议包括保持80字符的行长,使用双空格缩进,按照特定顺序组织文件内容,使用小写并反映目录结构的包名,以及使用CamelCase命名消息和字段。避免使用required字段和groups(仅针对proto2),并遵循枚举和重复字段的命名约定。
摘要由CSDN通过智能技术生成


此文档为.proto文件提供了样式指南。通过遵循这些约定,您将使您的协议缓冲区消息定义及其相应的类一致且易于阅读。

请注意,协议缓冲区样式是随着时间的推移而发展的,因此您可能会看到用不同约定或样式编写的.proto文件。修改这些文件时,Please respect the existing styleConsistency is key.。但是,在创建新的.proto文件时,最好采用当前最好的样式。

Standard file formatting

  • 保持行长为80个字符
  • 使用两个空格的缩进

File structure

应将文件命名为lower_snake_case.proto
所有文件应以下列方式排序:

  • 1.License header (if applicable)
  • 2.File overview
  • 3.Syntax
  • 4.Package
  • 5.Imports (sorted)
  • 6.File options
  • 7.Everything else

Packages

包名应该是小写的,并且应该对应于目录层次结构。例如,如果一个文件位于my/Package/中,那么包名应该是my.Package

Message an

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值