Diskussion zum Artikel "Automatisch generierte Dokumentation für den MQL5-Code"
Sie verpassen Handelsmöglichkeiten:
- Freie Handelsapplikationen
- Über 8.000 Signale zum Kopieren
- Wirtschaftsnachrichten für die Lage an den Finanzmärkte
Registrierung
Einloggen
Sie stimmen der Website-Richtlinie und den Nutzungsbedingungen zu.
Wenn Sie kein Benutzerkonto haben, registrieren Sie sich
Neuer Artikel Automatisch generierte Dokumentation für den MQL5-Code :
Die meisten Personen, die Codes in Java anlegen, kennen bestimmt die automatisch generierte Dokumentation, die zusammen mit JavaDocs erstellt werden kann. Hierbei geht es um die Ergänzung des Codes durch Anmerkungen auf semi-strukturierte Weise, die dann in eine leicht zu navigierende Hilfe-Datei extrahiert werden können. In der C++ Welt gibt es ebenfalls einige automatische Dokumentations-Generatoren, von denen SandCastle und Doxygen von Microsoft die beiden Spitzenreiter sind. Dieser Beitrag beschreibt die Verwendung von Doxygen zur Erzeugung einer HTML Hilfe-Datei auf Basis strukturierter Anmerkungen im MQL5-Code. Der Versuch hat prima funktioniert und ich glaube, dass die Hilfs-Dokumentation, die Doxygen aus dem MQL5-Code liefert ganz erheblichen Mehrwert mit sich bringt.
2. Doxygen
Doxygen ist ein automatischer Open Source Dokumentations-Generator, der unter der GNU-Lizenz für freie Dokumentation zur Verfügung steht, was bedeutet, dass seine Entwicklung anderen Open Sourcen Projekten wie z.B. Linux und Mozilla ähnelt. Doxygen kann gratis heruntergeladen und benutzt werden. Sein Quellcode steht jedem zur Verfügung und seine Entwicklung und weitere Verbesserung werden in gemeinschaftlicher Arbeit von einigen Entwicklern gemacht, die ihre Zeit zur Verfügung stellen.
Auf seiner simpelsten Nutzungsebene, zerlegt Doxygen einfach jeden C++ (oder MQL5) Code in einem Projekt und zeigt seine Struktur in einer leicht zu navigierenden Hilfe-Datei an. Dies ist insbesondere bei Objekt-orientierten Codesets hilfreich, die ja meist eine umfassende Klassenhierarchie und eine große Anzahl an Mitgliedfunktionen haben. Um jedoch alle Features von Doxygen auch komplett nutzen zu können, sollte de Code auch mit strukturierten Anmerkungen versehen sein, damit Doxygen diese lesen und in die generierte Hilfe-Datei entsprechende Informationen hinzufügen kann.
2.1 Doxygen herunterladen
Die Doxygen Homepage lautet: http://www.doxygen.org/. Dort gehen Sie einfach zur Download-Seite und laden sich dort die aktuelle Version für Windows herunter. Als dieser Beitrag entstand war das Doxygen-1.6.1, vgl. unten
Abb. 1 Doxygen herunterladen
Autor: Paul