Ich habe Excel Dna verwendet, um .NET-XML-Dateien zu erstellen und sie in meinen AddIn- und Excel-Arbeitsblattfunktionen zu verwenden. Ich verwende auch ExcelDnaPack.exe, um meine xll zu verpacken.
Ich habe mich gefragt, ob Excel dna unterstützt, irgendwelche Möglichkeiten, um Dokumentation für meine Bibliothek APIs zu generieren.
Danke, Mani
Zunächst können Sie Excel-DNA in den Excel-Funktionsassistenten mit Beschreibungen für die Funktionen und die verschiedenen Argumente integrieren. Diese werden Ihrer Funktion mit Attributen hinzugefügt:
%Vor%Der Funktionsassistent ermöglicht auch einen Hilfe-Link für jede Funktion.
Wenn Sie eine Hilfedatei haben, sagen Sie im .chm-Format, können Sie Excel-DNA anweisen, den Hilfe-Link wie folgt anzuschließen:
%Vor%Wie bekomme ich die Hilfedatei? Der C # - oder VB.NET-Compiler kann eine XML-Datei aus den XML-Kommentaren in Ihrem Code generieren. Diese .xml-Datei wird von etwas wie Sandcastle verarbeitet - hier ist eine ganze Diskussion zu diesem Teil: Generierung von Dokumentation aus C # XML-Kommentaren .
Aber Excel-DNA hat im Moment nichts, um die Funktionen und ihre Themen automatisch in Beziehung zu setzen. Ich bin nicht sicher, wie schwer es ist, die generierten TopicIds aus der Sandcastle-Ausgabe herauszufinden oder sie aus dem Code im XML-Kommentar zu setzen. Wenn es ein Problem ist, könnte ein automatisches Themen-Hookup oder sogar ein Hilfe-Generator-Tool ein nettes Feature sein, um es zu Excel-DNA in Zukunft hinzuzufügen.
Es ist auch üblich, einem Excel-DNA-Add-In ein Menüband mit einer Schaltfläche hinzuzufügen, die eine Hilfedatei für das gesamte Add-In anzeigt.
Bearbeiten: Es gibt jetzt ein Projekt mit Benutzereinbindung, das Excel-DNA verarbeitet, um Hilfedateien einfacher zu erstellen. Siehe Ссылка