57

C++ 用の Javadoc のような同様のドキュメント生成システムはありますか? Javadoc は適切な出力を生成します。他の言語でも同じようなものを使用できれば素晴らしいことです。

4

5 に答える 5

61

JavaDoc for C++ のように機能するツールがいくつかあります。最も人気のあるツールはおそらくdoxygenです。JavaDoc のようなコメントといくつかの言語 (C++、C、Java、Objective-C、Python、PHP、C# など) を処理できます。CSS を使用して HTML 出力のスタイルを微調整するための非常に優れたサポートがあります (ドキュメントの例については、ユーザー リストを参照してください)。

ドキュメンテーション システムを選択する際の 2 つの重要な点は、次のことを可能にすることです。

  • 関心のあるエンティティを文書化します。システムをコード構造に従って文書化しますか、それとも他のモジュール区分に従って文書化しますか。
  • 必要に応じてフォーマットされた出力を取得します。ドキュメントが一般的なプロジェクト スタイルに適合する場合に適しています。

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

于 2009-07-17T07:52:44.297 に答える
21

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

Doxygen
Doc++

于 2009-07-17T02:49:08.950 に答える
11

多くのこと (およびそれ以上) をサポートする doxygen があります。

于 2009-07-17T02:46:47.720 に答える
1

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

于 2012-06-19T06:26:09.073 に答える
1

Python プロジェクトでSphinxを使い始めたばかりです。そのホームページには、「C/C++ も既にサポートされています」と記載されています。

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

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

于 2015-09-08T17:20:09.980 に答える