私はかなり大きなオープン ソース RTS ゲーム エンジン ( Spring ) に取り組んでいます。私は最近、Lua で呼び出し可能な新しい C++ 関数を追加しました。それらをどのように文書化するのが最善かを考えています。同時に、多くの既存の Lua 呼び出しに関する文書を作成/更新するよう人々を刺激します。
したがって、ドキュメントを最初に C++ 関数の近くに doxygen コメントとして記述できればよいと考えました。これは、関数の本体が明らかに関数の動作を正確に定義しているため簡単です。ただし、一般的に git (私たちが使用する VCS) や C++ についてほとんど理解していない、エンジンを使用するゲーム開発者によってドキュメントが改善されることを望みます。
したがって、C++ ファイルから apidoc を自動的に生成する方法があれば理想的ですが、より幅広い視聴者がコメントを更新したり、例を追加したりできるようにする wiki のような Web インターフェイスも必要です。
だから私は、doxygen スタイルの書式設定、それらのコメントの wiki のような編集 (ソース ファイルの他の部分の編集を許可しないことが望ましい) と git を統合する Web ツールが存在するかどうか疑問に思っています。(Web インターフェイスを介して変更されたコメントを特別なブランチにコミットするため)
私たち開発者は、このブランチを時々マージして、マスター ブランチに改善を追加することができます。同時に、開発者によるドキュメントの改善は、マスター ブランチをこの特別なブランチにマージするだけで、この Web ツールに反映されます。ブランチ。
私はまだ何も見つけていません。この特定のものがまだ存在するのではないかと疑っていますので、どんな提案も大歓迎です!