Spezielle Tags

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 | Kapitel 10. Klassendokumentation mit KDoc | Vor

# 10.3. Spezielle Tags

Die Beschreibungen in diesem Kapitel sind der KDoc-Dokumentation des KDoc-Autors Sirtaj S. Kang (taj@kde.org) von 1997 entnommen.

In der Dokumentation erlaubt sind

- "normale" Textabschnitte, die durch mindestens eine Leerzeile voneinander getrennt werden müssen,

- Text in der Art von

         1 &<;pre&>;
         2 .....Code-Fragmente....
         3 &&<;/pre&>;

  sowie

- verschiedene Tags in folgender Schreibweise:

       @tagname [Tag-Parameter]

Folgende Tags sind für die einzelnen Code-Bestandteile zulässig:

- Klassen

         @short [ein Satz]
           eine kurze Klassenbeschreibung,
         @author [eine Zeile Text]
           der Autor der Klasse,
         @version [eine Textzeile]
           Klassenversion (Ich setze diese normalerweise auf das RCS/CVS-Tag "Id".),
         @see [ein oder mehrere Verweise auf Klassen oder Methoden]
           Verweise auf verwandte Dokumentation.

- Methoden

         @see
           wie oben,
         @return [ein Satz]
           Kurzbeschreibung des Rückgabewerts,
         @param [Name des Parameters] [Parameterbeschreibung]
          beschreibt einen Parameter. Die Parameterbeschreibung kann mehrere Zeilen
           umfassen und wird durch eine Leerzeile, ein Kommentarende oder einen neuen
           Parametereintrag abgeschlossen.
           Daher sollten Parametereinträge normalerweise an letzter Stelle
           im Dokumentationskommentar stehen.

- Konstanten, Aufzählungen, Eigenschaften

         @see
           wie oben.

- sowie `@ref`

  Abweichend vom Javadoc-Format hat der Metatag "@ref" dasselbe Format wie @see, kann jedoch an jeder beliebigen Stelle innerhalb der Dokumentation erscheinen (Alle anderen Tags müssen im Format "eins pro Zeile" auftauchen).

Zurück | Anfang | Vor
Klassen- und Memberdokumentation hinzufügen | Hoch | Internationalisierung