Das K Desktop Environment

Kapitel 10. Klassendokumentation mit KDoc

Ihre Dokumentation sollte eine Beschreibung der von Ihnen geschriebenen Klassenschnittstellen enthalten. So schaffen Sie sich und anderen Programmierern die Mglichkeit, sich Ihre Klassen durch das Lesen der ber KDoc zugnglichen HTML-Klassendokumentation zu erschlieen oder Ihr Wissen rasch aufzufrischen. KDevelop untersttzt 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, fgen Sie das Dokumentationsgerst fr Ihre API hinzu, indem Sie "API-Dokumentation erstellen" aus dem "Projekt"-Men whlen. Damit werden alle Header-Files durchgesehen und das HTML-Gerst erstellt. Nun knnen Sie die erstellte Dokumentation ber den Menpunkt "API-Dokumentation des Projekts" aus dem Hilfe-Men bzw. ber das entsprechende Buchsymbol im Katalog "Aktuelles Projekt" auf der Karteikarte DOC aufrufen.

Sie enthlt ganz ohne Ihr Zutun bereits Verweise auf die KDE- und Qt-Klassendokumentation , so dass Sie Vererbungen einfach verfolgen knnen. Auf diese Weise werden Sie gleichzeitig mit der KDE- und Qt-Dokumentation vertraut.