web-dev-qa-db-ja.com

C ++用のJavadocのようなドキュメント

C++用のJavadocのような類似のドキュメント生成システムはありますか？ JavadocはNice出力を生成します。他の言語でそのようなものを使用できれば素晴らしいと思います。

javac++javadoc
53
DHamrick

C++用のJavaDocのように機能するツールがいくつかあります。最も一般的なツールは、おそらく doxygen です。 JavaDocのようなコメント、および複数の言語（C++、C、Java、Objective-C、Python、PHP、C＃など）も処理できます。 CSSを使用してHTML出力のスタイルを微調整するためのかなり良いサポートがあります（ドキュメントの例については sers list を参照してください）。

文書システムを選択する際の2つの重要な問題は、それができることを確認することです

  • 関心のあるエンティティを文書化します。コード構造に従って、または他のモジュール分割に従ってシステムを文書化しますか。
  • 出力を希望どおりにフォーマットします。ドキュメントが一般的なプロジェクトスタイルに適合する場合に適しています。

Doxygenの経験では、セットアップと使用が非常に簡単であり、結果の出力を微調整するのは非常に簡単です。残念ながら、doxygenは完全ではないため、場合によってはdoxygenパーサーが故障する癖やバグを回避する必要があります。生成されたすべてのドキュメントを注意深く確認してください。

56
Zayenz

特にjavadocを使用することはできませんが、必要なことを行うツールがいくつかあります。ほとんどの人が使用する傾向があるのはDoxygenです。 DoxygenおよびDoc ++のリンクを次に示します。

酸素
Doc ++

20
Ben Lakey

多くのものをサポートするdoxygenがあります（さらに） Doxygen

11
Grant Limberg

QTベースのC++プロジェクト用のqdocもあります。 http://doc-snapshot.qt-project.org/qdoc

1
Yair

Sphinx をPythonプロジェクトに使用しています。ホームページには、「C/C++も既にサポートされています」と記載されています。

「 reStructuredText 」と呼ばれる軽量のマークアップを使用します。

Pythonプロジェクトに使用し始めたばかりで、出力の外観がとても気に入っています。

0
Dan H