protocolbuffers/protobuf

support documentation in code generated bindings

Open

#985 opened on 2015年11月18日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)C++ (71,223 stars) (16,128 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.