web-dev-qa-db-ja.com

SphinxはすでにC ++ドキュメントに適していますか?

C++の新しいプロジェクトのドキュメントジェネレーターを試してみたい。私の選択肢はDoxygenまたはSphinxのいずれかだと思います。私はPythonにSphinxを使用したいプロジェクトがあるので、SphinxもC++の正しい選択かどうか疑問に思います。 Sphinx ウェブサイトはC++はサポートされていますが、C++のドキュメントを開始するためのドキュメントが見つかりませんでした。

同様の質問はすでに Stackoverflowで説明されています であり、主な答えは次のように結論付けられます:

まだ完全には使用できません。
しかし見続ける

議論は1年以上前なので、この結論はまだ有効かどうか疑問に思います。 C++のドキュメントでは、SphinxよりもDoxygenを選択する必要がありますか?

38
clstaudt

Sphinxは、単独ではC++ソースからドキュメントを抽出できません。ただし、拡張機能があります。最も顕著なのは Breathe で、Doxygenを使用してC++からドキュメントを抽出します。これらのいずれもテストしていません。

21
lunaryorn

C++の場合、Doxygenは非常に優れています。 C++のSphinxサポートは、Doxygenを介して行われます( Breathe を使用)。

保守性を向上させるために、2つの言語に対して1つのツールのみが必要です。 DoxygenはPython codeからドキュメントを生成できるため、Doxygenを使用することをお勧めします可能であれば、両方のソースについて これはDoxygenとPythonのチュートリアルです

1
Synxis