Offizielles Doxygen-Handbuch

doxygen ist ein nützliches Hilfstool für Programmierer. Es kann das Hinzufügen von Batch-Code zum Programm erleichtern. Es ist mit gängigen Programmiersprachen wie C++, C, Java, Objective-C, Python usw. kompatibel. Das vom Herausgeber bereitgestellte Doxygen-Chinesisch-Handbuch enthält grundlegende Einführungen, Grammatikkenntnisse und fortgeschrittene Fähigkeiten usw., sodass Sie schnell loslegen können. Wenn Sie es benötigen, können Sie es gerne herunterladen.

Grundlegende Einführung

Doxygen unterstützt bereits die Generierung von ANSI-codierten CHM-Verzeichnisdateien (index.hhc)! Die Generierung chinesischer Dokumente erfordert eine Änderung der Eingabe- und Ausgabekodierungssysteme, wodurch die Analysemethode geändert und chinesische Dokumente generiert werden können. Sie müssen sich jedoch darüber im Klaren sein, dass Doxygen beim Extrahieren von Informationen aus Kommentaren eine grammatikalische Analyse durchführen muss. Diese Analyse basiert auf Englisch und es ist auf dieser Ebene nicht möglich, Chinesisch zu unterstützen.

Doxygen ist ein Dokumentationsgenerator für die Sprachen C++, C, Java, Objective-C, Python, IDL (CORBA- und Microsoft-Varianten), Fortran, VHDL, PHP, C# und D. Läuft auf den meisten Unix-ähnlichen Systemen sowie auf Mac OS X-Betriebssystemen und Microsoft Windows. Die ursprüngliche Version von Doxygen entlehnte einige Codes aus der älteren Version von DOC++; anschließend wurde der Doxygen-Quellcode von Dimitri van Heesch neu geschrieben.

Das Doxygen-Handbuch ist in drei Teile gegliedert, jeder Teil enthält mehrere Kapitel.

Der erste Teil ist die Bedienungsanleitung

1. Installation, erläutert, wie Sie doxygen auf Ihrer Plattform herunterladen, kompilieren und installieren.
2. Beginnen wir damit, Ihnen zu erklären, wie Sie schnell das erste Doxygen-Dokument erstellen.
3. Codedokumentation, die verschiedene Möglichkeiten demonstriert, wie Code dokumentiert werden kann.
4. Liste mit verschiedenen Möglichkeiten zum Erstellen einer Liste.
5. Kombination, zeigt, wie man einige Arbeiten miteinander kombinieren kann.
6. Enthält Formeln und zeigt, wie Formeln in das Dokument eingefügt werden.
7. Grafiken und Diagramme, Beschreibung der von doxygen generierten Diagramme und Grafiken.
8. Vorverarbeitung und Analyse, wie Doxygen mit Makrodefinitionen umgeht.
9. Generieren Sie automatische Links, die zeigen, wie Links zu Dateien, Klassen und Mitgliedern im Dokument platziert werden.
10. Ausgabeformat, zeigt, wie verschiedene von doxygen unterstützte Ausgabeformate generiert werden.
11. Suche, zeigt verschiedene Möglichkeiten zur Suche in HTML-Dokumenten.
12. Benutzerdefinierte Ausgabe: Analysieren Sie, wie Sie eine benutzerdefinierte Ausgabe in Doxygen generieren.
13. Benutzerdefinierte Befehle, die zeigen, wie Sie benutzerdefinierte Befehle in Ihren Kommentaren definieren und verwenden.
14. Stellen Sie eine Verbindung zu externen Dokumenten her und erklären Sie, wie Sie mit doxygen Links zu extern generierten Dokumenten erstellen können.
15. FAQ, Antworten auf häufig gestellte Fragen.
16. Fehlerbehebung: Hier erfahren Sie, was zu tun ist, wenn etwas schief geht.

Der zweite Teil ist das Referenzhandbuch

1. Funktionen, die einen Überblick über die Funktionen von Doxygen zeigen.
2. Doxygen-Historie, informiert Doxygen über Veränderungen während des Entwicklungsprozesses und was es getan hat.
3. Doxygen-Verwendung, erklären Sie, wie man Doxygen verwendet.
4. Doxytag-Nutzung, erklären Sie, wie Sie Doxytag verwenden.
5. Verwendung von Doxywizard, erklären Sie, wie Sie Doxywizard verwenden.
6. Installdox-Nutzung: Erklären Sie, wie Sie das generierte Installdox-Skript in doxygen verwenden, wenn Sie Tag-Dateien verwenden.
7. Konfiguration, die erklärt, wie man doxygen anpasst, um die benötigte Dokumentation zu erstellen.
8. Spezielle Befehlswörter, die einen Überblick über die speziellen Befehle geben, die im Dokument verwendet werden können.
9. HTML-Befehlswörter, die einen Überblick über die HTML-Befehle geben, die im Dokument verwendet werden können.
10. XML-Befehlswörter, die einen Überblick über XML-Befehle im C#-Stil bieten, die in Dokumenten verwendet werden können.

Der dritte Teil enthält einige Informationen für Doxygen-Entwickler (weggelassen)

1. Interne Struktur von Sauerstoff, gibt einen Gesamtüberblick über die interne Struktur von Sauerstoff.
2. Ausgabeformat des Perl-Moduls, das zeigt, wie die Ausgabe von PerlMod verwendet wird.
3. Internationalisierung, Analyse, wie Ausgabeunterstützung für neue Sprachen hinzugefügt werden kann.