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.