如何让protoc在生成Python代码时保留.proto文件注释？

原生的protoc Python代码生成器（包括grpc_tools提供的版本）不支持将.proto中的注释导出到生成的.py/.pyi文件，这和C#生成时自动转XML文档的逻辑不同。针对你的需求（让PyCharm能显示注释），可以用以下几种方案：

方案1：使用第三方代码生成器 #

推荐使用betterproto，它专门优化了Python代码生成逻辑，支持将.proto中的注释转为Python的文档字符串，PyCharm可直接识别显示。

• 安装依赖：

  pip install betterproto[compiler]
  

• 生成代码的命令：

  python -m grpc_tools.protoc -I protos/V1/ --python_betterproto_out=client/ protos/V1/service.proto
  

生成后的Python类和字段会带有对应的注释，在PyCharm中使用时会自动弹出提示。

方案2：配置PyCharm直接读取.proto注释 #

如果不想替换官方生成器，可以借助PyCharm插件直接关联.proto文件的注释：

• 安装PyCharm官方的Google Protocol Buffers插件
• 在PyCharm设置中，将你的.proto文件目录添加到Languages & Frameworks > Protocol Buffers > Import Paths
  这样在使用生成的Python代码时，PyCharm会自动匹配对应的.proto文件，展示原始注释内容。

方案3：自定义protoc插件（进阶） #

如果有高度定制需求，可以编写一个protoc插件，在代码生成阶段提取.proto中的注释并注入到生成的.py/.pyi文件中。不过该方案需要熟悉protoc插件的开发逻辑，实现成本较高，适合有定制化需求的场景。

内容的提问来源于stack exchange，提问作者ChrisH