VS 2010 C＃XMLドキュメントからHTML /ヘルプファイルを生成する

StackOverflow https://stackoverflow.com/questions/4781784

質問

VS2010 XMLドキュメントからHTML /ヘルプファイルを作成する優れたツールを探しています。などの商用ツールをいくつか見つけました

もっとあると確信しています。例として、これら2つをリストするだけです。また、XMLをHTMLドキュメントに変換するための単純なXSLTスタイルシートもあります。

何を使用しているのか、たとえば、コンバージョンを行うための無料のツールがあります。おそらくアドインとして。明確にするために、基本的に私は2種類のツールを見つけました。

  1. XMLドキュメントファイルをさまざまなターゲット形式で変換するものは、これが私が探しているものです。
  2. ソースコードでXMLドキュメントを生成するのに役立つツール。これは（！）私が探しているものではありません。

ご協力いただきありがとうございます。

Sandcastle / SHFBコンボはうまく機能します。助けてくれたすべての人に感謝します。

いくつかの発言：

  1. NDOCは時代遅れのようで、最後の更新は2005年です。だから私はこれをスキップしました。
  2. 同様のスレッドも非常に詳細で、ここにあります： https://stackoverflow.com/questions/3082044/how-turn-c-xml-doc-comments-into-something-useful ヒントをありがとう！
  3. サンドキャッスルにはいくつかの情報源があり、私が見つけた最新バージョンはここにあります： http://sandcastle.codeplex.com/
  4. 生成するため MsHelp2 VS 2008 SDKが含まれているのをインストールする必要がありました hscomp.exe. 。私が理解できる限り、バージョン1.0と1.1があります。バージョン1.0にはコンパイラが含まれています。見る HelixSoft と ソーシャルMSDN いくつかの詳細について。
  5. 私の場合、生成されたWebhelpはChromeで正しく機能しません。常にindex.htmlページをリロードします。
  6. ここでトピック Sandpace InfosをSandcastleドキュメントに追加する方法を示します。
  7. 2012年11月現在の更新：私が使用している小規模なプロジェクトの場合 ドキシゲン - 構成が少し簡単だと思います。
役に立ちましたか？

解決

サンドキャッスルを使用して、Transformation＆Sandcastle Help File Builderをユーザーインターフェイスとしてファイルして、ヘルププロジェクトを管理しています。私の意見では、サンドキャッスルとSHFBの美しさは、「平均的な」ソースコードドキュメントに加えて、プログラムのアーキテクチャ、従わなければならないパターン、または結び付けられていないプロジェクトの追加の構想コンテンツなどの追加情報を追加できます。プログラムの1つのクラスに直接。これは、Microsoft Autheringスキーマの助けを借りて追加のXMLファイルを作成することで実行できます（XMLファイルとしてVisual Studioで編集でき、Schemaを使用できます）。これらの両方のツールから、MSDNのようなドキュメントを作成するのは非常に簡単です。

ずっと前に、私は技術的な側面でほぼ同じドキュメントブックを試しました（情報とXSLTファイルを含むXMLファイルをさまざまな出力タイプに変換しました）。しかし、それは私たちにとって選択肢ではありませんでした。なぜなら、Visual Studioで生成されたXMLドキュメントを使用できる変革はないためです（さらに、概念的コンテンツの変換はかなり苦痛でした）。

他のヒント

XMLコメントからドキュメントを作成できる2つの無料ツール：

Sandcastle + SHFBは素晴らしいコンボです。無料でHTML、CHMなどを生成します

ライセンス： CC-BY-SA と 帰属
所属していません StackOverflow
scroll top