C# / VisualStudio 2008 でコード ドキュメントをエクスポートするにはどうすればよいですか?

Question

私は常に、C# xml 構文を使用してクラスとメソッドの優れたコード コメントを書くようにしてきました。私は、後で簡単にエクスポートできることを常に期待していました。

今日、実際にそうしなければならないのですが、その方法がわかりません。何か足りないものはありますか？私は行ってみたい メニュー -> ビルド -> ビルド コード ドキュメント, 、しかし、そこにはそれを行うオプションはありません。

Answer 1

実際にはプロジェクトのプロパティにあります。[ビルド] タブ、[出力] セクション、XML ドキュメント ファイルを選択し、ファイル名を入力します。これはプロジェクトのすべてのビルドにビルドされます。

その後、実際のヘルプを構築できます 砂のお城.

Answer 2

試してみてもいいでしょう NDOC または 砂のお城 サードパーティのツールを使用しても構いません。

Answer 3

砂のお城 ドキュメントの生成には非常にうまく機能し、生成用にいくつかの異なる形式をサポートしています。私の知る限り、Visual Studio との統合はありませんが、 サンドキャッスルGUI それは利用可能です。

Answer 4

LINQ to SQL を使用している場合は、自動生成されたオブジェクトに持続可能なコメントを簡単に追加できないため、注意してください。

Answer 5

コメントが遅くなりましたが、たとえサンドキャッスルが保存されていたとしても、 Sandcastle ヘルプ ファイル ビルダー は現在も開発が活発に行われており、この状況に対処する場合、非常に強力で簡単に取り組むことができることがわかりました。数時間でリッチな .chm および .html/.asp 出力をインストールできます。

Answer 6

元の NDoc プロジェクト (他の人が言及した) は廃止されましたが、と呼ばれる新しいプロジェクトがあります。 NDoc3.

NDoc3 は .NET 2.0 ～ 3.5 をサポートします。現在ベータ版として利用可能ですが、私にとっては非常にうまくいきました。このプロジェクトがまだアクティブであるかどうかはわかりません。最後のベータ版は 2009 年 4 月にリリースされました。