Klassendokumentation mit KDoc

Das KDevelop-Programmierhandbuch: Leitfaden zur C++-Anwendungsentwicklung für das K Desktop Environment (KDE) mit Hilfe der KDevelop-IDE in der Version 1.2
Zurück |  | Vor

# Kapitel 10. Klassendokumentation mit KDoc

Ihre Dokumentation sollte eine Beschreibung der von Ihnen geschriebenen Klassenschnittstellen enthalten. So schaffen Sie sich und anderen Programmierern die Möglichkeit, sich Ihre Klassen durch das Lesen der über `KDoc` zugänglichen HTML-Klassendokumentation zu erschließen oder Ihr Wissen rasch aufzufrischen. KDevelop unterstützt `KDoc` in allen Belangen, indem es die KDE-Library-Dokumentation erstellt, sogar Ihr Application-Framework ist schon vordokumentiert. Um sich in den so vorgegebenen Code einzuarbeiten, bietet es sich an, die beiliegenden Dokumentationsdateien am Rechner durchzusehen. Im Folgenden sehen Sie, wie man eine API-Dokumentation erstellt, wie KDevelop Ihnen hilft, sie in Ihr Projekt einzubinden, und welche speziellen Tags `KDoc` erlaubt.

# 10.1. So nutzen Sie KDevelops Dokumentationsfeatures

Nachdem Sie ein Projekt erstellt haben, fügen Sie das Dokumentationsgerüst für Ihre API hinzu, indem Sie "API-Dokumentation erstellen" aus dem "Projekt"-Menü wählen. Damit werden alle Header-Files durchgesehen und das HTML-Gerüst erstellt. Nun können Sie die erstellte Dokumentation über den Menüpunkt "API-Dokumentation des Projekts" aus dem Hilfe-Menü bzw. über das entsprechende Buchsymbol im Katalog "Aktuelles Projekt" auf der Karteikarte DOC aufrufen.

Sie enthält ganz ohne Ihr Zutun bereits Verweise auf die KDE- und Qt-Klassendokumentation , so dass Sie Vererbungen einfach verfolgen können. Auf diese Weise werden Sie gleichzeitig mit der KDE- und Qt-Dokumentation vertraut.

Zurück | Anfang | Vor
Hilfe anfordern in Dialogen |  | Klassen- und Memberdokumentation hinzufügen