protocolbuffers/protobuf

support documentation in code generated bindings

Open

#985 创建于 2015年11月18日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)C++ (71,223 star) (16,128 fork)batch import
P3enhancementhelp wanted

描述

A nice to have feature would be to copy over documentation present on the protobuf files into the code generated files for cpp, python. I believe it works for java currently.

贡献者指南

技术栈
cpppython
领域
developer experiencedocumentation
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Protocol BuffersC++ code generationPython code generation
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
30
研究方向
Investigate how Java documentation is currently copied in the protobuf code generation (likely in src/google/protobuf/compiler/java/). Then examine the corresponding C++ and Python generators (src/google/protobuf/compiler/cpp/, src/google/protobuf/compiler/python/) to modify them to include comments from .proto files. Look at how the Java generator extracts comments (e.g., using SourceLocation) and replicate that logic for the other languages.