API ドキュメントへの .Net XML コメント

質問

Visual Studio XML 出力から MSDN スタイルのドキュメントを生成する簡単な方法はありますか?
この橋を渡るのは私が初めてではないことが分かっているので、適切な xslt をセットアップするほど忍耐力がありません。

あと、最近砂の城を立ててみたんですが、本当に目がよぎりました。プロセスで何か重要なことを見逃していたか、単に複雑すぎるかのどちらかです。

私は誰かが本当に素晴らしい、非常にシンプルな解決策を持っていることを知っています。

ここで繰り返し述べているのは、私の書式設定により、その段落が読みにくくなっていると思うからです。

Sandcastle を試してみましたが、セットアップするのに非常に苦労しました。私が本当に考えていることは、もっと単純なことです。

ただし、砂の城のプロセスを理解していない場合は別です。テスターが作業するのに便利なものを作成するだけで、私には非常に多くの余分な荷物のように思えました。

解決

サンドキャッスルを探しています

.NET 用の NDoc コードドキュメントジェネレーター以前は最適なツールでしたが、サポートはほぼ終了しました。

他のヒント

見て砂のお城, 、まさにそれを行います。これは、世の中で最もシンプルなソリューションの 1 つであり、多かれ少なかれ選ばれるツールであるため、セットアップ中に発生した問題を指定していただければ、長期的には Sandcastle のセットアップをお手伝いできるかもしれません。

Sandcastle ヘルプファイルビルダーも使用する必要があります。ヘルプファイルを生成するための NDOC のような GUI が提供されるため、コマンドプロンプトから何もする必要はありません。

フォローするこのシンプルな 5 ステップの記事これでほぼ完了です。ボーナスとして使えるのは、 H2ビューア HTML ヘルプ 2.x ファイルを表示します。

Sandcastle を再度セットアップしました。これ (2008 年 5 月リリース) をインストールして、SandcastleGui.exe または類似のものを検索してください (サンプルフォルダーなどにあります)。

[アセンブリの追加] をクリックしてアセンブリを追加し、.xml ドキュメントファイル (オプションを有効にした場合にコンパイラによって生成されるファイル) を追加して、ビルドします。

時間はかかりますが結果は意思努力する価値があるでしょう。実際には MSDN から情報を検索するため、作成されるドキュメントには、MSDN などへのリンクを含む System.Object に至るまでのクラス継承も含まれます。

Sandcastle は、特に自動ビルドで使用する場合、最初は少し複雑に思えますが、努力する価値があると確信しています。

こちらもご覧ください Sandcastle ヘルプファイルビルダー, これは、それをもう少し高度にした GUI です。

私が使う NDoc3

ライセンス： CC-BY-SA と帰属

所属していません StackOverflow