2009-06-08 4 views
1

Ich erstelle eine benutzerdefinierte Bibliothek mit zusammengesetzten Steuerelementen, die ihre eigenen JavaScript-Dateien als Webressourcen enthalten. Ich habe DocProject ausgeführt, um meine XML-Dokumentations-CHMs zu generieren, und es funktioniert großartig.JavaScript XML-Kommentardokumentation

Allerdings, wenn ich meine Lösung auf Konfiguration „Release“ ist, wird die Laufzeit noch nicht Extrahieren der XML-Kommentare aus den eingebetteten JavaScript-Dateien und sie in der generierten comments.xml Datei oder .org Reflexion Datei enthält. Wenn ich meinen DocProject-Build ausführe, sind die Kommentare, die ich in meine JavaScript-Dateien eingefügt habe, daher ausgeschlossen, was meine Dokumentation unvollkommen macht.

Irgendwelche Gedanken? Ich würde gerne die JavaScript-Dokumentation direkt in das generierte CHM einbinden.

Ich habe seit AjaxDoc auf CodePlex betrachtet, und hatte nach etwa 6 Stunden keinen Erfolg damit. Ja, ich habe Bertrand LeRoy bereits kontaktiert (Autor von AjaxDoc) und hoffe, etwas zurück zu hören, obwohl ich sicher bin, dass er ziemlich beschäftigt ist.

Antwort

0

Ihre Frage scheint nichts mit Javascript oder XML an sich zu tun zu haben, sondern mit DocProject, das Sie vielleicht in Ihre Tags einfügen möchten.

+0

Die vom .NET-Framework generierte XML-Datei exportiert die XML-Kommentare nicht in die JavaScript-Datei. Es ist nicht DocProject, das verschmutzt, es ist die Tatsache, dass meine "JAVASCRIPT" -Datei "XML" "COMMENTS" nicht in der "DOKUMENTATION" -Datei angezeigt wird, die von ".NET" generiert wird. Vielleicht verstehst du jetzt das Tagging. :) – Jonathan

0

Ein paar Punkte, die Sie verstehen helfen, was los ist:

Die XML-doc-Dateien aus den Kommentaren auf kompilierten Quellcode gebaut werden. Javascript ist nicht kompiliert.

Die einzige Unterstützung, die Visual Studio für XML-Dokumente auf JS hat, ist im JS-Code-Editor-Fenster für Intellisense und Code-Vervollständigung. Das ist es.

AjaxDoc ist ein ziemlich komplexes Biest, das nur auf JS funktioniert, das mit MsAjax erstellt wurde und sein Schreibsystem nutzt.

AjaxDoc kann nicht XML-Dateien für POJO (Plain ole‘Javascript)

bauen würde ich nicht meinen Atem für jede Antwort von Betrand halten.

Ich arbeite gerade an einer POJO Dokumentation Engine, aber meine Arbeit hat mich beschäftigt. Sie können einen In-Browser-Tool zum Erstellen von On-Demand-Dokumenten im Verzeichnis/docs von this download

sehen. Die Neuigkeiten sind nicht besser.

Verwandte Themen