Visual Studio C++ - Dokumentationsgenerator
Gibt es eine Möglichkeit, Dokumentation (wie Javadoc) in einem Visual-C++ - Projekt zu erhalten?
Ich benutze Visual Studio 2010.
vielen Dank!
Sie können auch das von VS2010 unterstützte Format XML-Documentation verwenden. http://msdn.Microsoft.com/de-de/library/ms177226%28VS.80%29.aspx
Nachdem Sie Ihren Code kommentiert haben, können Sie Sandcastle verwenden, um eine MSDN-ähnliche Dokumentation zu erstellen: http://sandcastle.codeplex.com/ . (Hier ist eine grafische Benutzeroberfläche für Sandcastle, die viel einfacher zu verwenden ist: https://github.com/EWSoftware/SHFB )
Ich verwende AtomineerUtils , um die XML-Documentation-Header automatisch zu erstellen. Dieses Tool wird Ihnen sehr helfen. Sie können eine kostenlose Basisversion hier erhalten: http://www.atomineerutils.com/products.php
Sie können einen Blick auf Doxygen werfen.
Sie können mein Addin, Atomineer Pro Documentation verwenden, um Dokumentationskommentare im Format Documentation-XML, Doxygen, Qt oder JavaDoc schnell zu generieren. Verwenden Sie dann Sandcastle (DocXml) oder Doxygen (DocXml, Doxygen, Qt, Javadoc), um diese Dokumentation in externe Dokumentationsdateien zu konvertieren.
Ich empfehle, das DocXml-Format zu verwenden, da alle oben genannten Werkzeuge damit arbeiten und Visual Studio es erkennt (die Syntax färbt es ein und baut die Dokumente in ihre Intellisense-Datenbank ein, sodass sie in der QuickInfo-Hilfe angezeigt werden, während Sie class/method eingeben Namen in Ihren Code).
Schauen Sie sich auch die Kommentare CppTripleSlash - xml doc für c ++ an. Es ist eine kostenlose Erweiterung für Visual Studio 2015, 2013, 2012, 2010.
Eine Möglichkeit, Dokumentation zu erstellen, ist - Sie haben es erraten - Javadoc . Sie müssen einfach auf die gleiche Weise kommentieren, wie Sie es normalerweise tun, und javadoc konvertiert sie gut in den HTML/LaTeX-Stil.
Natürlich ist das nicht die einzige Lösung. Ich werde Raum für andere lassen.
Wenn Sie nichts dagegen haben, einige handgeschriebene Dokumentation, dann ist Sphinx das perfekte Werkzeug.
http://www.sphinx-doc.org/de/stable/
und hier ist ein Beispiel:
sphinx-build -b singlehtml doc/ build/
Wenn Sie Visual Studio 2015 verwenden, gibt es einen Doxygen-Generator für die Macro Explorer-Erweiterung, der JavaScript für seine Makrosprache verwendet.
Projekt ist auf github hier: https://github.com/cppocl/visual_studio_macros