2012-10-17 6 views
32

C++で新しいプロジェクトのドキュメントジェネレータを試してみたいと思います。私は自分のオプションがDoxygenかSphinxのどちらかと思う。私はPythonでSphinxを使いたいプロジェクトを持っているので、SphinxもC++に適しているのだろうかと思います。 SphinxのWebサイトにはC++がサポートされていると書かれていますが、C++のドキュメントを手に入れるためのドキュメントが見つかりませんでした。SphinxはC++のドキュメントには適していますか?

同様の質問がすでにdiscussed on Stackoverflowされていると主な答えは結論:

をまだ十分に使用可能な、
しかし議論は、古い年を優に超えるあるので

を見続けるこの結論が依然として有効かどうかは疑問です。 C++のドキュメントでSphinxよりDoxygenを選択する必要がありますか?

+3

私はスフィンクスについて知らないが、私はDoxygenが本当に素晴らしいツールだと思う! Doxygenについて、あなたはどのような問題を発見しましたか? – lucasg

+3

@georgesl現時点で私がDoxygenに持っている唯一の問題は、私がPythonプロジェクトにSphinxを使用し、2つの異なるドキュメントシステムを使わないようにしたいということです。それぞれの作業を開始して構文に慣れていくには、おそらく時間がかかります。 – clstaudt

+0

ウェブサイトの右側のサイドバーには、GoogleグループとFreeNodeのチャットハンドルへのリンクがあります。あなたはそれらを試しましたか?私は必ずしもこの質問がここに属していないと言っているわけではありません、ちょうどあなたがそこに情報に基づいた回答を得る可能性が高いと思います。 –

答えて

18

スフィンクスは、C++ソースからドキュメントを抽出することはできません。ただし、Doxygenを利用してC++からドキュメントを抽出する拡張機能があります。特にBreatheがあります。私はこれらのどれもテストしていません。

+0

Breatheを使用する場合、私はまだ変わったDoxygen構文を使用する必要があるようです。 : - / –

0

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

メンテナンス性を向上させるために、2つの言語に対して1つのツールのみを使用したいとします。 Doxygen can generate a documentation from Python codeですので、可能であれば、両方のソースにDoxygenを使用することをお勧めします。 Here is a tutorial for Doxygen and Python

+18

私は何年ものPythonプログラミングでDoxygenを使ったPythonプロジェクトを見たことがない。これはPythonコミュニティでは絶対に非標準的なツールです。問題がある場合は、多くの助けが必要です。 – lunaryorn

+1

あなたの議論は '誰もそれを使用していないため、DoxygenはPythonにとって悪いですか?申し訳ありませんが、これは真実ではありません。たとえば、http://code.foosel.org/doxypy、http://www.stack.nl/~dimitri/doxygen/docblocks.html#pythonblocks、http://engtech.wordpress.com/2007/03を参照してください。/20/automatic_documentation_python_doxygen /(DoxygenにPythonでinteresstedされている人がいます)。 – Synxis

+7

一部のGoogleの結果は、それがコミュニティの非標準ツールであるという私の声明を本当に打ち消すものではありません。重要なプロジェクトでのDoxygenの普及はありますが、それはありません。かなりのPythonプロジェクトでは文書化のためにDoxygenを使用していません。ヘック、ゾープさえしません... – lunaryorn

関連する問題