Visual Studio 2010でWinFormsアプリのヘルプファイルを作成する必要があります。理想的には、完全に別個のツールではなく、VisualStudioと統合するツールを使用したいと思います。
以前はHTMLヘルプワークショップを使用していましたが、これは古く、使用するのが少しファンキーだったことを思い出します。 Visual Studio 2005 SDKにツールが組み込まれていることも知っていますが、2010年には何かが必要です。
これは、ツールベンダーにとって厄介なターゲットです。ほとんどのショップでは、ヘルプは、日常の活動でVisualStudioをまったく使用していないプロのライターによって作成されています。 RoboHelpのようなサードパーティのオーサリングツールは、推奨される武器です。
おそらく見たVS2005SDKツールは HelpStudio Lite 、Innovasysの製品でした。 VS2010と統合し、 フォーラム投稿 から判断して利用可能なバージョンはありません。リリースするつもりはありません。彼らのドキュメントX!しかし、製品はそうですが、あなたが見なければならないもののように聞こえます。 evalバージョンはダウンロード可能です ここから 。
ここにあなたのオプションがあります...
VS統合を備えたMicrosoftのドキュメントジェネレータが必要な場合:
ただし、 DocProjectはまだVS2010を完全にはサポートしていない 。
非MSソリューションの場合、 GhostDoc があります。これはdoes VS 2010統合をサポートしており、より優れたソリューションのようです。
Visual Studioに統合しないオプションの場合:
1年ほど前、JoelのThe Business of Softwareフォーラムの何人かの人々が HelpNDoc を推奨していたことを覚えています。
フォーラムディスカッション: http://discuss.joelonsoftware.com/default.asp?biz.5.359131.1
documentxまたはsandcastleを使用したghostdocが最適です... 2010年になると、残りはすべて非常に原始的です。c#とC++の両方のプロジェクトがある場合は、documentxがC#だけであれば、どちらでもかまいません。
ヘルプファイルの対象読者がアプリケーションのユーザーであるhtmlhelp 2が使用できない場合でも、chmファイルを作成する必要があります。 winformsアプリケーションからこれを行うことができるツールは Help Generator for Visual Studio です。これは、ヘルプの準備とフォームへのリンクで多くの作業を不要にします。
他の人が言っているように、すべてのクラスレベルのメンバーとオブジェクトでSandcastleを使用して、トリプルスラッシュXMLMSDNスタイルのヘルプを変換できます。
/// <summary>
/// I am a method help Header
/// </summary>
/// <param name="parm1">info for param 1</param>
/// <param name="parm2">info for parm2</param>
/// <remarks>Some Extra Info</remarks>
public override void MeMethod(SourceElement rootElm, Subject subject){
...
これが Sandscastle へのリンクです。
より機能豊富なヘルプジェネレーターはVisual Studio 2010と統合され、複数のヘルプ形式を生成します VSDocMan 。 WYSIWYGコメントエディタが含まれており、実際にコードの一部にコメントを付けてくれます。非常に役立つ
おそらくVS2010と統合されていませんが、'97年頃にRoboHelpを使用したことを覚えていますが、それは問題ありませんでした。ヘルプファイルを作成する必要がある場合は、まだ存在しているように見えるので、別の外観を与えると思います ここ 。見た目はかなり高額ですが、他の理由でいくつかのアドビライセンス(開発ショップでは珍しくありません)を持っている場合は、すでにこれを持っている可能性がありますか?
多くの調査を行っており、さまざまなツールをテストした後、 http://www.helpgenerator.com/ がヘルプシステムをまとめる最速の方法です。
Html Helpは、Html Help 2に置き換えられました。