問題タブ [doxygen]

私は、C または PHP コードのドキュメントを作成するために Doxygen が好きです。/* .. */私は近日中に Python プロジェクトを予定していますが、Python にはコメントがなく、独自の自己文書化機能も備えていることを覚えていると思います。

私は Doxygen に精通しているので、それを使用して Python ドキュメントを作成するにはどうすればよいですか? 特に注意しなければならないことはありますか？

ActionScript ファイルを文書化するように DoxyGen を構成するにはどうすればよいですか?

*.as および *.asi ファイルを dox​​ygen の検索パターンに含めましたが、クラス、関数、および変数がそこに表示されません。

Doxygenは少し遅いです-プロジェクト全体を処理するのに約数分かかるので、小さな増分変更の場合、これは実際に残りのコードをビルドするよりも長くなります。ドキュメントのないファイルは何千もあるので、それらの処理にほとんどの時間を費やしていると思います。ドキュメントなしでファイルをスキップする方法はありますか？

変更されたファイルのみを処理するようにするのはどうですか？

テンプレートを含むいくつかの C++ ソース コードがあります。たとえば、doxygen はエラーなしで実行されますが、出力にドキュメントが追加されません。何が起こっているのでしょうか?

ビルドごとに (かなり小さい) プロジェクトの doxygen ドキュメントを生成しています。これを達成するために次のことを行いました。

1. index.htmldoxygen が生成する をプロジェクトに追加しました
2. このファイルのカスタム ビルド ステップを指定しました (プロジェクト全体ではありません)。
   • コマンドライン：doxygen ../doc/Doxyfile
   • 出力:..doc/html/index.html
   • 追加の依存関係: '../bin/foo.exe'

これに関する問題は、VS がプロジェクトが古くなっていることを通知しなくなるまで、2 回ビルドする必要があることです。
どうすればこれを修正できますか?

CACMの記事から、DoxygenはJava（および他のいくつかの言語）でも動作することがわかりました。しかし、JavaにはすでにJavadocツールがあります。誰かがどちらのアプローチの長所と短所を説明できますか？それらは相互に排他的ですか？Doxygen用のMavenプラグインはありますか？

Doxygen を使用して、C と x86 アセンブリ言語が混在するレガシー コードを文書化したいと考えています。アセンブリ言語はインラインではなく、個別のアセンブリ専用ファイルにあります。アセンブリ言語部分を文書化するにはどうすればよいですか?

doxygenがダイアグラムの作成にgraphvizライブラリを使用していることに気づきました。ドキュメントの生成にgraphvizを使用したことがありますか？doxygenの範囲外の文書化の目的でgraphvizを学ぶ価値はありますか？それとも、Visioのような標準のデータモデリングパッケージを使い続けるほうがいいですか？

グラフライブラリとしてのメリットは理解していますが、より複雑なUML（または同様のもの）を表現しようとする場合でも、調査する価値はありますか？

常識的には、Doxygen コメント ブロックは、クラス、構造体、列挙型、関数、宣言があるヘッダー ファイルに配置する必要があります。これは、ソースなしで配布されることを意図したライブラリ (オブジェクト コードを含むヘッダーとライブラリのみ) の妥当な議論であることに同意します。

しかし...私は、完全なソースコードで使用される社内の (または自分自身のサイドプロジェクトとして) ライブラリを開発しているときに、正反対のアプローチを考えていました。私が提案するのは、実装ファイル (HPP、INL、CPP など) に大きなコメント ブロックを配置して、ヘッダーで宣言されたクラスと関数のインターフェイスが乱雑にならないようにすることです。

長所：

• ヘッダー ファイルの混乱が少なくなり、関数の分類のみを追加できます。
• たとえば、Intellisense の使用時にプレビューされるコメント ブロックは衝突しません。これは、.H ファイルに関数のコメント ブロックがあり、同じ .H ファイルにそのインライン定義がある場合に見られる欠陥です。ただし、.INL ファイルから含まれています。

短所：

• (明らかなもの) コメント ブロックは、宣言があるヘッダー ファイルにはありません。

それで、あなたは何を考え、おそらく提案しますか？

Doxygen を使用して HTML ドキュメントを単一の非常に長いファイルとして作成するにはどうすればよいですか? RTF出力のようなものが欲しいが、HTMLとして。

理由: API を単一の印刷可能なドキュメントとして公開する必要があります。Word に読み込めるもの、PDF に変換できるものなど。