Wie kann man die "Inline-Dokumente" einer .cpp-Datei anzeigen?

465
Mala

Ich habe CPP-Dateien mit Kommentaren wie den folgenden vor jeder Funktion gespickt:

/** * @brief Set the normal and expansion handshake timeouts. * * @param wm Array of wiimote_t structures. * @param wiimotes Number of objects in the wm array. * @param normal_timeout The timeout in milliseconds for a normal read. * @param exp_timeout The timeout in millisecondsd to wait for an expansion handshake. */

Ich gehe von dem Format aus, dass es eine Möglichkeit geben muss, dieses in ein "friendly" -Format zu exportieren, vielleicht html, das dann ähnlich wie die Java-API gelesen werden kann. Wie würde ich das machen?

(Ich arbeite unter Windows 7 und führe MS Visual Studio 2010 aus.)

1

1 Antwort auf die Frage

3
RBerteig

Der von Ihnen angegebene spezifische Dokumentenkommentarstil ist fast sicher für die Verarbeitung durch Doxygen gedacht . Es kann aus Kommentaren in Quellen vieler C-ähnlicher Sprachen eine anständige Qualitätsdokumentation in verschiedenen Ausgabeformaten erzeugen. Es gibt auch Plugins, mit denen Kommentare in einigen Nicht-C-Sprachen verarbeitet werden können, um sie in dasselbe Dokument aufzunehmen.

Wenn Sie die AT & T Graphviz- Tools installiert haben und Doxygen für deren Verwendung konfigurieren, können Sie auch eine Reihe nützlicher Diagramme aus dem Quellcode ziehen, um sie in die Dokumentation aufzunehmen.

Wenn das Projekt Doxygen verwendet, gibt es fast sicher eine Konfigurationsdatei, die angibt, welche Quelldateien einbezogen werden sollen, welche Formate zu generieren sind und welche Optionen für die detaillierte Verarbeitung relevant sind. Es würde wahrscheinlich genannt doxyfilewerden oder etwas ähnliches.

Ein allgemeines Ausgabeformat ist der HTML-Code für eine vollständige Website. Ein online verfügbares Beispiel ist die Website für Doxygen selbst, die fast ausschließlich durch das Ausführen von Doxygen im Quellbaum erzeugt wird.

Ich empfehle Doxygen für Projekte, die in C-ähnlichen Sprachen verfasst sind. Die Disziplin, "gut genug" Kommentare zu schreiben, ist oft nützlich und liefert eine klare Aussage über den "Vertrag", den jede Funktion zu erfüllen hat. RBerteig vor 13 Jahren 0

Verwandte Probleme