Keeping Quellcode wartbar ist eine der größten Herausforderungen für jeden Software-Entwickler , ob ein einsamer Wolf Programmierer oder ein Mitglied eines großen Teams . Doxygen Dokumentation können Sie erzeugen automatisch von C + + , Java oder anderen Code . Es analysiert Ihre undokumentierten Code und schreiben grundlegende Dokumentation , und Sie können speziell formatierten Kommentaren zu Ihrem Quellcode einfügen , um hilfreiche Ergänzungen zu den generierten Quellcode zu machen. Things You
Quellcode
Text Editor
brauchen anzeigen Weitere Anweisungen
1
herunterladen und installieren Doxygen . Er steht am stack.nl /~ dimitri /doxygen /download.html # latestsrc .
2
Öffnen Sie eine Eingabeaufforderung . Unter Windows XP können Sie dies , indem Sie auf das Start-Menü zu tun , die Wahl Run , Eingabe von " cmd" , und klicken Sie auf OK. Unter Mac OS können Sie auf das Spotlight-Menü , Typ -Terminal, und wählen Sie Terminal- wenn es erscheint. Navigieren Sie an der Eingabeaufforderung den Quellcode Verzeichnis durch Eingabe von " cd" durch den Namen des Verzeichnisses gefolgt und die Eingabetaste drücken .
3
erstellen Doxyfile durch Eingabe von " doxygen - g" und drücken Sie Enter. Dadurch wird eine Datei im aktuellen Verzeichnis mit dem Namen " Doxyfile ", die alle standardmäßig Doxygen Optionen enthalten wird. Sie können diese Optionen , indem Sie das Doxyfile in einem Text-Editor ändern.
4
hinzufügen Doxygen Kommentare zum Quelltext . Doxygen Kommentare sind normale Kommentare , die spezielle Anmerkungen, Doxygen , sie zu finden und zeigen, wie es sollte sie nutzen aktivieren enthalten . Zum Beispiel, wenn Sie in einer C -style Sprache schreiben , können Sie eine kurze Beschreibung einer Funktion hinzufügen, indem Sie den folgenden Kommentar , bevor seine Erklärung :/* ! \\ brief Meine kurze Beschreibung * /Sie können sehen, alle anderen Anmerkungen Doxygen unterstützt bei stack.nl /~ dimitri /doxygen /docblocks.html .
5
Type " doxygen Doxyfile " auf Eingabeaufforderung und drücken Sie die Eingabetaste . Dies erzeugt in der Dokumentation zum Quellcode.
