ソリューション内のプロジェクトの 1 つに Doxygen HTML ドキュメントをインストールして作成したいと考えています。プロセスを順を追って教えてください。私はグーグルで検索しましたが、そのような情報はどこにも見つかりませんでした。
編集: Visual Studio 2008 に統合できますか?
ソリューション内のプロジェクトの 1 つに Doxygen HTML ドキュメントをインストールして作成したいと考えています。プロセスを順を追って教えてください。私はグーグルで検索しましたが、そのような情報はどこにも見つかりませんでした。
編集: Visual Studio 2008 に統合できますか?
Doxygen のドキュメントを試しましたか? :) http://www.doxygen.nl/manual
私がすることは、インストール プロジェクトを調べて、作成しているメソッドの概要を示すボイラープレートの例をいくつか作成することです。小さく始めましょう。
編集: VS 2008 での使用に関する投稿を見たところです。その特定のバージョンで Doxygen を試したことはありませんが、Doxygen が認識するタグでコメントをマークアップしているだけなので、可能であると思われます。
http://www.doxygen.nl/download.htmlから doxygen doxygen-1.8.2-setup.exe をダウンロードしてインストールしました。次に、それを実行し、ドキュメントが必要なプロジェクトのディレクトリとその他のオプションを指定しました。それだけです!
最初に、doxygen がインストールされ、システム パスにアクセスできることを確認する必要があります。グラフを描画するために、graphviz (dot) をインストールすることもできます。
次に、次を実行します。
doxygen -g MyProject.doxyconf
これにより、doxygen 構成ファイルが生成されます。このファイルを編集してカスタマイズします。オプションの機能を説明するコメントが含まれているので、それに応じて設定してください。
以下を使用して doxygen ドキュメントを生成できるようになりました。
doxygen MyProject.doxyconf
これを Visual Studio と統合するには、新しい makefile プロジェクト (例: MyProject.documentation) を作成します。これは、次のコマンドを実行するように構成できます。
Build : doxygen MyProject.doxyconf
ReBuild : doxygen MyProject.doxyconf
Clean : cd $(ProjectDir)/docs && del /s *.*
注: が正しいかどうかはわかりませんが、ドキュメントが生成された場所$(ProjectDir)
に変更する必要があります。$(ProjectDir)/docs
その後、必要に応じてドキュメントをプロジェクトに追加できます。これに関する私のアドバイスは、繰り返し行うことです。1 つの領域 (ヘッダー/クラス) から始めて、doxygen が生成する出力を確認し、段階的に改良していきます。
http://www.doxygen.nl/manual/docblocks.htmlは、doxygen ドキュメントを追加する基本を示しています。
http://www.doxygen.nl/manual/commands.htmlは、doxygen コメント内で使用可能なすべてのコマンドのリファレンスを提供します。
http://www.doxygen.nl/manualは、追加のドキュメントを提供します。