Ich habe eine .NET C# -Komponente erstellt, die ich als Entwickler-Tool verkaufen werde. Meine Frage ist, wie füge ich den Methoden und Eigenschaften meine eigene benutzerdefinierte Kontexthilfe hinzu.Wie füge ich Kontexthilfe zu einer Assembly hinzu
Also, wenn ich F1 über eine Methode drücken möchte ich es auf eine bestimmte Webseite gehen. Ist das überhaupt möglich?
Verwenden Sie das Visual Studio SDK und die Hilfe-Integrations-Kit Ein Teil des Visual Studio SDK ist die Projekttyp Hilfe Integration. Informationen zu integrating with help here (MSDN). Gleiches gilt für VS 2005 und 2008.
Hier ist ein link to the download, für frühere Versionen von VS (vor '05).
Es gibt eine entire development center über das Visual Studio SDK.
Der Aufwand fühlt sich viel höher als eine CHM Versand und/oder IntelliSense-Dateien, aber ich verstehe Sie Beispiele hinzufügen möchten, usw.
Überlegen Sie, ob es die Mühe wert ist Sie bereitstellen, sind genügend Informationen in den IntelliSense-Dokumentationsdateien (.xml) für alle Baugruppen Ihrer Komponente?
Mehr als oft nicht, das ist ausreichend, um eine Vielzahl von Informationen zur Verfügung zu stellen, einschließlich dem zusätzlichen Bemerkungen, Notizen usw.
ich nur auf meine Entwicklung Workflow voreingenommen sein kann und die meine Mitarbeiter, aber ich kann Erinnere dich an das letzte Mal, als ich jemanden gesehen habe, drücke "F1" in Visual Studio.
Und wenn Sie wirklich eine vollständige .Chm-Hilfedatei benötigen, können Sie Ihre XML-Dokumentationskommentare dank Tools wie Sandcastle und früher NDoc mit wenig Aufwand in diese konvertieren.
Abgesehen von der herkömmlichen F1-Hilfe finde ich, dass Sandcastle-erstellte CHM-Dateien beim Bereitstellen wiederverwendbarer Bibliotheken und Frameworks äußerst hilfreich sind. GhostDoc hat sich als sehr nützlich für die Erstellung der In-Code-XML für Sandcastle CHM-Dateien verwendet. Sandcastle bietet auch die Möglichkeit, HTML-Hilfedateien im MSDN-Stil sowie das bewährte CHM zu erstellen.
Die Kontexthilfe wird über die XML-Dokumentation in Ihrem Code generiert.
Wenn Sie mit ihm nicht vertraut sind, in C# .NET Sie eine Funktion, indem Sie drei aufeinanderfolgende Vorwärtsschrägstriche vor der Methodensignatur dokumentieren:
/// <summary>
/// What Foo() does...
/// </summary>
/// <param name="bar">What bar is...</param>
/// <returns>What the return int is...</returns>
public int Foo(string bar)
{
// Does something...
}
In VB.NET, ich glaube, es ist drei Apostrophe .
Vorausgesetzt, Sie sind vertraut mit der Verwendung von XML-Kommentaren zum Erstellen der XML-Intellisense-Datei und können Sandcastle verwenden, um .chm-Dateien separat zu generieren, dann ist das fehlende Stück F1-Integration.
Dieser Artikel ist alt, aber zeigt how to do it with VS 6.0 era help
Die Kommentare, die Sie dort direkt zu the 2003 integration kit
Jenseits, die Sie scheinen die tatsächliche VS SDK zu haben herunterzuladen.
This page scheint ziemlich auf dem neuesten Stand (es Informationen über Änderungen im Jahr 2010 hat)
Danke für den Kommentar. Ich habe bereits die XML-Dokumentation für alle Methoden erstellt. Das Problem ist, ich möchte es nicht mit komplexen Beispielen aufblähen. Halten Sie diese getrennt mit der Online-Dokumentation. Ich möchte auch keine lokale .CHM-Datei. Ich dachte, vielleicht war es einfach, den F1-Haken zu überschreiben, um es auf eine Seite umzuleiten. Können Sie URL-Links in die XML-Dokumentation einfügen? Sie können also direkt von Ihrem Code aus geklickt werden? – Andy
Hinzufügen des wichtigen Links –