2009-07-01 4 views
2

Ich habe mehrere Projekte, einige mit verwaltetem Code und einige mit nur nicht verwalteten. Alle haben die XML-Kommentare hinzugefügt und die XML-Dokumentation wird korrekt generiert (die generierte XML-Datei und dazwischen die xdc-Dateien).C++ XML-Kommentare zum Generieren von MSDN-Stil CHM

Sicherlich gibt es etwas, das diese Dateien nehmen kann (die Ausgabe von xdcmake) und MSDN-Stil erzeugen chm help! ? Soweit ich weiß, ignorieren sowohl Doxygen als auch Sandcastle diesen offensichtlichen Schritt und erfinden das Rad neu, um den Code erneut zu scannen. (Es gibt auch die Tatsache, dass Sandcastle für Nicht-.NET-Projekte scheinbar nutzlos ist).

Doxygen (schreckliche Ausgabe, aber schnell) und Sandcastle (nette MSDN-Ausgabe, aber sloooooow) versucht beide von etwas viel einfacher zu übertreffen.

Es wäre auch schön, wenn es einen Editor gäbe, der auch die Seiten 'Erste Schritte' und 'Information' schreiben könnte, die auch für jede API-Dokumentation benötigt werden.

Kennt jemand irgendwelche Lösungen?

Antwort

0

Sie möchten vielleicht DoxyComment versuchen. Hier ist die Beschreibung von Doxygen des Helper tools & scripts:

Ein Addin für Visual Studio 2005 genannt DoxyComment von Troels Gram erstellt wurde. Es wurde entwickelt, um Sie in assistieren kontextsensitiven Kommentar Blöcke in C/C++ - Quelldateien zu unterstützen. DoxyComment kommt auch mit einem xslt Vorlage, mit der Sie Dokumentation wie die MSDN-Bibliothek generieren können.

+0

Ich habe mir das in der Vergangenheit kurz angeschaut, vielleicht sollte ich es noch einmal versuchen. Vielen Dank. – cmroanirgo

0

Ehrlich gesagt ist Sandcastle Ihre beste Wette. Ich weiß, dass die Konfiguration etwas mühsam sein kann, aber die Dokumentation ist genau der Stil, nach dem Sie suchen.

+0

Sandcastle, soweit ich weiß, funktioniert nicht mit nicht verwalteten Projekten. Gibt es eine Möglichkeit, sie zum Laufen zu bringen? – cmroanirgo

0

weiß, dass ich das Projekt, wo die Menschen noch NDocConsole

verwenden jedoch nehme ich an, dass NDoc ein totes Projekt ist, weil auf http://ndoc.sourceforge.net/ es keine Updates sind seit 2005