Verfügt Visual Studio über eine Option zum Generieren von HTML-Dokumentation für Kommentare im Javadoc-Stil? Wenn ja, welche Schritte sind dazu notwendig?
In BlueJ gibt es eine Option, Kommentare im Javadoc-Stil in eine HTML-Datei zu übersetzen.
Wie das folgende Bild für Java mit BlueJ zeigt, möchte ich dasselbe mit Visual Studio tun: http://www.time-tripper.com/uipatterns/Patterns/Titled_Sections/javadoc.gif http://www.time-tripper.com/uipatterns/Patterns/Titled_Sections/javadoc.gif
Antworten:
8 für die Antwort № 1Meinst du eigentlich JavaDoc, in Java? Wenn ja, glaube ich nicht - verwenden Sie einfach javadoc selbst. Visual Studio unterstützt Java nicht wirklich.
Wenn Sie C#-XML-Dokumentationskommentare meinen, können Sie die Projekteigenschaften ändern, um die XML-Datei zu erstellen, und dann verwenden NDoc (eingestellt) bzw Sandburg um HTML (oder chm usw.) zu erstellen. Es ist zugegebenermaßen nicht so einfach, wie es sein könnte.
BEARBEITEN: Wenn Sie C++ verwenden, sollten Sie sich wahrscheinlich ansehen Doxygen. Möglicherweise gibt es Visual Studio-Plugins, aber Sie könnenFühren Sie am besten einfach Doxygen als Teil Ihres Build-Prozesses aus. Wenn Sie C++/CLI verwenden, gibt es möglicherweise ein Äquivalent zu C#-XML-Kommentaren, aber ich weiß nichts davon.
0 für die Antwort № 2
Sie können einen Javadoc-kompatiblen Kommentarstil verwenden, indem Sie die Kommentare entweder von Hand eingeben oder mein Add-In verwenden. Atomineer Pro-Dokumentation um ihm die meiste Arbeit zu nehmen. Verwenden Sie dann zum Generieren einer externen Dokumentation Sauerstoff, das fröhlich javadoc liest.
Die Alternative ist (wie Jon gesagt hat) zu verwendenKommentare im XmlDoc-Format, die von Visual Studio (für Intellisense-QuickInfos), Atomineer, Sandcastle und Doxygen verwendet werden können. Es ist ein weniger menschenlesbares Format, bietet Ihnen jedoch erhebliche Vorteile innerhalb der Visual Studio-Umgebung, sodass es etwas flexibler ist.
Beide Ansätze funktionieren für C#, C++, C (obwohl C# auf der Intellisense-Seite besser funktioniert)