Quickstart Doxygen: Unterschied zwischen den Versionen

Aus HSHL Mechatronik
Zur Navigation springen Zur Suche springen
(Die Seite wurde neu angelegt: „== Einleitung == Dieser Artikel soll eine Hilfe sein, beim erstellen oder aktualisieren von Dokumentationen von Quellcode mit Doxygen. == Was ist Doxygen == == Anleitung == = Schritt 1: Doxygen installieren = Als erstes sollten sie überprüfen, ob Doxygen schon installiert ist. Dafür können Sie zum Beispiel in der Windows-Suchleiste nach "Doxywizard" suchen. Sollten sie dieses Programm nicht haben, ist Doxygen nicht auf ihrem Gerät installiert. Um…“)
 
Keine Bearbeitungszusammenfassung
 
Zeile 6: Zeile 6:
== Anleitung ==
== Anleitung ==


= Schritt 1: Doxygen installieren =
=== Schritt 1: Doxygen installieren ===
Als erstes sollten sie überprüfen, ob Doxygen schon installiert ist. Dafür können Sie zum Beispiel in der Windows-Suchleiste nach "Doxywizard" suchen.
Als erstes sollten sie überprüfen, ob Doxygen schon installiert ist. Dafür können Sie zum Beispiel in der Windows-Suchleiste nach "Doxywizard" suchen.
Sollten sie dieses Programm nicht haben, ist Doxygen nicht auf ihrem Gerät installiert.
Sollten sie dieses Programm nicht haben, ist Doxygen nicht auf ihrem Gerät installiert.
Zeile 14: Zeile 14:




= Schritt 2: Doxygen-Konfigurationsdatei erstellen =
=== Schritt 2: Doxygen-Konfigurationsdatei erstellen ===


= Schritt 3: Konfigurationsdatei anpassen =
=== Schritt 3: Konfigurationsdatei anpassen ===


= Schritt 4: Kommentare in deinem Code hinzufügen =
=== Schritt 4: Kommentare in deinem Code hinzufügen ===


= Schritt 5: Dokumentation generieren =
=== Schritt 5: Dokumentation generieren ===

Aktuelle Version vom 15. Oktober 2024, 13:14 Uhr

Einleitung

Dieser Artikel soll eine Hilfe sein, beim erstellen oder aktualisieren von Dokumentationen von Quellcode mit Doxygen.

Was ist Doxygen

Anleitung

Schritt 1: Doxygen installieren

Als erstes sollten sie überprüfen, ob Doxygen schon installiert ist. Dafür können Sie zum Beispiel in der Windows-Suchleiste nach "Doxywizard" suchen. Sollten sie dieses Programm nicht haben, ist Doxygen nicht auf ihrem Gerät installiert.

Um Doxygen nun zu installieren, laden Sie sich hier die aktuelle Version herunter.


Schritt 2: Doxygen-Konfigurationsdatei erstellen

Schritt 3: Konfigurationsdatei anpassen

Schritt 4: Kommentare in deinem Code hinzufügen

Schritt 5: Dokumentation generieren