26

私はVS2010 XMLドキュメントからHTML /ヘルプファイルを作成するための優れたツールをお探しになります。私は、このようなVS 2010からのHTML /ヘルプファイルの生成C#XMLドキュメント

など、いくつかの商用ツール、私はより多くの、私は一例として、これら二つのリストがあります確信しているを発見しました。 XMLをHTMLドキュメントに変換するための単純なXSLTスタイルシートもあります。

何を使用していますか?変換を行うための無料のツールが、おそらくアドインとして存在します。ただ、明確にする 、基本的に私はツールの2種類を発見した:

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

ありがとうございました。


サンドキャッスル/ SHFBコンボは素晴らしいです。助けてくれたすべての人に感謝します。

いくつかの発言:

  1. たNdocは時代遅れのようです、最後の更新は、私はこれをスキップした理由です2005年からです。
  2. 同様のスレッドもここにあります。How to turn C# Xml Doc-Comments into something useful?ヒントありがとう! http://sandcastle.codeplex.com/
  3. MsHelp2を生成するために、私はhscomp.exeを含むVS 2008 SDKをインストールする必要がありました:
  4. は、私がここに配置されて発見したサンドキャッスル、最新バージョンのいくつかの要因があります。バージョン1.0と1.1があります。バージョン1.0にはコンパイラが含まれています。詳細については、HelixsoftおよびSocial MSDNを参照してください。
  5. 私の場合、生成されたWebHelpはChromeで正しく動作しません。 index.htmlページは常にリロードされます。
  6. topic hereには、ネームスペースの情報をサンドキャッスルのドキュメントに追加する方法が示されています。
  7. 2012年11月現在のアップデート:小規模なプロジェクトの場合は、Doxygenを使用しています。設定が簡単です。 XMLコメントからドキュメントを作成できるよう
+2

[C#Xml Doc-Commentsを便利なものにするにはどうすればいいですか?](http://stackoverflow.com/questions/3082044/how-to-turn-c-xml-doc-comments-into-something -useful) – jgauffin

+0

うん、私は何らかの理由でこれを見なかった。私はツールのいくつかをチェックしたらこれを更新します。 –

+1

XML文書を読むための利用可能なAPIのリストにNuDocを追加できますか? http://kzu.to/nudoc – kzu

答えて

19

変換用にSandcastleを使用しています&サンドキャッスルヘルププロジェクトを管理するためのユーザーインターフェイスとしてのヘルプファイルビルダーです。私の意見では、サンドキャッスルとSHFBの美しさは、「平均的な」ソースコードのドキュメントのほかに、プログラムのアーキテクチャ、従わなければならないパターン、またはプロジェクトに結び付けられていない追加の概念的なコンテンツプログラム内の1つのクラスに直接アクセスできます。これは、Microsoft Authoring Schemaの助けを借りて追加のxmlファイルを作成することによって行うことができます(xmlファイルとしてVisual Studioで編集でき、スキーマは利用可能です)。両方のツールでドキュメントのようなMSDNを作成するのはかなり簡単です。

私はずっと前に、テクニカルサイド(xmlファイルには情報とxsltファイルが入っていて、それをさまざまな出力タイプに変換する)でほぼ同じです。しかし、私たちにとってはオプションではありませんでした。なぜなら、ビジュアルスタジオで生成されたxmlドキュメントを使用できる変換がないからです(概念的なコンテンツの変換もかなり苦労していました)。

+0

Sandcastle/SHFBはうまくいきます。以下にいくつかの発言。 –

3

つ以上無料ツール:

+1

Afaik、NDocは.NET 2以降をサポートしていません。例えばジェネリックのドキュメントなど – codeulike

+0

簡単な訪問者を実装するだけで、ドキュメンテーションのメンバーを読み込んで何かを生成する簡単なAPIもあります。NuDoc http://kzu.to/nudoc – kzu

3

サンドキャッスル+ SHFB素晴らしいコンボです。無料でhtml、chmなどを生成します

関連する問題