Welche Instrumente stehen zur Verfügung eine Hilfedatei in Visual Studio 2010 erstellen?

Question

Ich brauche eine Hilfe-Datei für eine WinForms-Anwendung in Visual Studio 2010. Im Idealfall zu schreiben, ich möchte ein Werkzeug verwenden, die integriert mit Visual Studio, sondern als ein völlig separates Werkzeug.

In der Vergangenheit habe ich HTML Help Workshop verwendet, aber dies ist sehr alt, und ich erinnere mich, es war ein wenig funky Einsatz. Ich weiß, dass es auch ein Werkzeug war das Visual Studio 2005 SDK gebaut in, aber ich brauche etwas für das Jahr 2010.

Answer 1

Es ist ein schwieriges Ziel für Tool-Anbieter. In den meisten Geschäften wird die Hilfe von professionellen Autoren verfasst, die in nicht ihren Tag zu Tag Aktivitäten für Visual Studio jede Verwendung haben. Dritte-Authoring-Tools wie RoboHelp ist ihre bevorzugte Waffe der Wahl.

Das VS2005 SDK Tool, das Sie wahrscheinlich sah, war Helpstudio Lite , ein Produkt von Innovasys. Es gibt keine Version zur Verfügung, die integriert mit VS2010 und Beurteilen von einem Forum posten sie haben nicht die Absicht, ein Lösen der Bremse. Ihre Document X! Produkt jedoch nicht, klingt wie, was Sie sollten einen Blick auf nehmen. Die eval-Version steht zum Download bereit von hier .

Answer 2

Hier sind Ihre Optionen ...

Wenn Sie Microsoft-Dokumentation Generator mit VS-Integration:

• Sandcastle Help File Builder für Hilfedatei Generation
• DocProject integrieren es in VS

Obwohl scheint es, dass DocProject nicht ganz VS2010 unterstützen noch .

Für die Nicht-MS-Lösung gibt es GhostDoc , die hat Unterstützung VS 2010-Integration und erscheint eine bessere Lösung zu sein.

Für Optionen, die Integration nicht in Visual Studio:

• Doxygen
• Docu
• NDoc3

Answer 3

Ich erinnere mich, dass ein Jahr oder so vor einigen Leute auf Joels The Business of Software Forum wurden empfehlen HelpNDoc .

Diskussionsforum: http://discuss.joelonsoftware.com/default. asp? biz.5.359131.10

Answer 4

Wie schon andere gesagt haben, können Sie die dreifache slash XML MSDN-Stil Hilfe konvertieren mit Sandcastle auf alle Klasse-Level-Mitglieder und Objekte

/// <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){
...

Hier ist der Link zu Sandscastle

mehr feature-rich Hilfe-Generator, dass integriert mit Visual Studio 2010 und erzeugt mehrere Hilfeformate ist VSdocman . Es enthält einen Kommentar WYSIWYG-Editor, und tatsächlich einige Ihren Code für Sie kommentiert. Extrem nützlich

Answer 5

Geister doc mit DocumentX oder Sandburg ist der Weg zu gehen ... Rest ist alles noch sehr primitiv ist, wenn es um 2010 kommt Wenn Sie sowohl c Projekt # und C ++ dann DocumentX die Art und Weise sein, wenn sie nur C # dann irgendeine ist gut.

Answer 6

Wenn das Publikum für Ihre Hilfedatei ist der Benutzer in der Anwendung HTML Help 2 nicht verwendbar ist, werden Sie noch eine CHM-Datei erstellen müssen. Das Werkzeug, das dies für Ihr von Ihrem WinForms-Anwendung tun kann, ist Help Generator Visual Studio , die eine Menge Arbeit wegnimmt in die Hilfe der Vorbereitung und Verknüpfung mit den Formen.

Answer 7

nicht integriert Wahrscheinlich nicht mit VS2010, aber ich erinnere mich mit RoboHelp wieder um '97 und es war ok: ish dann so, wenn ich zu schreiben Hilfe-Dateien benötigen jetzt würde ich wahrscheinlich geben, dass ein anderen Blick, da es scheint, als ob es noch da ist < a href = "http://www.adobe.com/products/robohelp/" rel = "nofollow noreferrer"> hier . Ziemlich teuer, obwohl es scheint, aber wenn Sie haben einige Adobe Lizenzen bekam (die nicht vollständig unsual für ein Entwicklungsgeschäft ist) aus einem anderen Grund vielleicht haben Sie schon bekam das?

Answer 8

HTML-Hilfe, wird ersetzt durch HTML-Hilfe-2.

http://www.mshelpwiki.com/wiki/tiki -index.php? page = Help2

Answer 9

Just wurde eine Menge Forschung zu tun und nach verschiedenen Tools Testen der http://www.helpgenerator.com/ ist der schnellste Weg, um ein Hilfesystem zusammen.