75

私は現在 C# プロジェクトに取り組んでおり、VisualAssist はこれらの凝っ/// <summary></summary>たコメントを生成してくれます。コードを文書化するためにそれらを使用しています。

これらのコメントを使用して、Doxygen や Javadoc のような HTML ドキュメントを作成する方法が必要だと思います。それ、どうやったら出来るの？

4

4 に答える 4

52

DoxygenまたはSandcastle ヘルプ ファイル ビルダーは、XML ドキュメントを外部ドキュメントの HTML (およびその他の形式) に抽出する主要なツールです。

これらのドキュメント エクスポーターをドキュメント ジェネレーターと組み合わせることができることに注意してください。ご存知のように、Resharper には基本的なヘルパーがいくつかありますが、GhostDoc (XML ドキュメントを含む C#/VB コード用) など、この特定のタスクを実行するためのより高度なツールもあります。 ) または私のアドインAtomineer Pro ドキュメント(C#、C++/CLI、C++、C、VB、Java、JavaScript、TypeScript、JScript、PHP、XML を含む Unrealscript コード、Doxygen、JavaDoc または Qt ドキュメント用)。

于 2013-03-09T22:37:53.293 に答える
4

このページに興味があるかもしれません: http://msdn.microsoft.com/en-us/magazine/dd722812.aspx

コマンドライン コンパイラまたは Visual Studio インターフェイスを使用して、XML ドキュメント ファイルを生成できます。コマンドライン コンパイラでコンパイルする場合は、オプション /doc または /doc+ を使用します。これにより、アセンブリと同じ名前で同じパスに XML ファイルが生成されます。別のファイル名を指定するには、/doc:file を使用します。

Visual Studio インターフェイスを使用している場合は、XML ドキュメント ファイルを生成するかどうかを制御する設定があります。これを設定するには、ソリューション エクスプローラーで [マイ プロジェクト] をダブルクリックして、プロジェクト デザイナーを開きます。[コンパイル] タブに移動します。ウィンドウの下部にある [XML ドキュメント ファイルの生成] を見つけて、チェックされていることを確認します。デフォルトでは、この設定はオンになっています。アセンブリと同じ名前とパスを使用して XML ファイルを生成します。

于 2013-03-09T22:30:12.200 に答える