2008-09-09 3 views
19

私はいつもクラスとメソッドの素晴らしいコードコメントをC#xml構文で書いています。私はいつも後で簡単にそれらをエクスポートすることができると予想していました。C#/ VisualStudio 2008でコードドキュメントをエクスポートするにはどうすればよいですか?

今日私は実際にそうしなければなりませんが、どうやって見つけ出すのが難しいですか。私は行方不明のものがありますか?私はメニュー - >ビルド - >ビルドコードドキュメントに行きたいが、それを行うオプションはありません。

+0

_OPにこの提案が追加されました:_このリンクは、高速で汚れたエクスポートのための簡単なxsltを持っています:http://www.codeproject.com/KB/XML/XMLDocStylesheet.aspx – Mogsdad

答えて

24

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

その後、Sandcastleで実際のヘルプを作成できます。

+0

XMLをより良い結果にフォーマットするために、XSL/XSLTを書くことができます。 – Biri

4

サードパーティのツールを使用したくない場合は、NDOCまたはSandCastleを試すことができます。

+0

このリンクは質問に答えるかもしれませんが、ここで答えの本質的な部分を含めると、参照のためのリンクを提供することをお勧めします。リンクされたページが変更された場合、リンクのみの回答は無効になります。 - [レビューの投稿](/ review/low-quality-posts/18546091) – Nae

1

Sandcastleは、ドキュメンテーションを生成するのには非常に効果的ですが、生成には2つの異なるフォーマットがサポートされています。私が知る限り、Visual Studioとの統合はありませんが、利用できるのはSandcastleGUIです。

1

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

0

元々のNDocプロジェクト(他人に言及されています)は死んでいますが、NDoc3という新しいプロジェクトがあります。

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

1

サンドキャッスルがモスボールされているにもかかわらず、Sandcastle Help File Builderがアクティブな開発に残っています。このような状況に対処するときは強力で簡単です。豊富な.chmおよび.html/.asp出力に数時間でインストールできます。

関連する問題