Doxygen und Code-Dokumentation – Features

Vorschau der Dokumentation

Eine Vorschau der Doxygen-Dokumentation wird im Schnelldokumentations-Popup (Strg+Q) angezeigt. Doxygen-Befehle werden dort auf attraktive Weise zusätzlich zu den Typinformationen geparst und ausgerichtet.

Alle Funktionsparameter werden getrennt von der Funktionsbeschreibung dokumentiert. CLion führt alle Kommentare zusammen und zeigt eine umfassende Dokumentation der Funktion (ebenso wie Doxygen bei der Generierung der Ausgabe).

Sicheres Umbenennen

Sorgen Sie für eine fehlerfreie Dokumentation, indem Sie die Refaktorierung „Rename“ Shift+F6 verwenden, um den Namen oder die Parameter einer Funktion zu aktualisieren. CLion aktualisiert sowohl die Doxygen-Befehle als auch andere Referenzen.

Nutzen Sie die Vervollständigung

Um Ihnen das Tippen zu vereinfachen, bietet CLion eine automatische Vervollständigung für Doxygen-Befehle und Funktionsparameter.

Dokumentationen generieren

Um einen neuen Doxygen-Befehl für eine Funktion hinzuzufügen, generieren Sie diesen einfach. Geben Sie dazu /**, /*!, /// oder //! ein und drücken Sie anschließend die Enter-Taste. Im Falle, dass Ihre Funktion Parameter enthält, einen Wert zurückgibt oder eine Ausnahme auslöst, wird ein Stub generiert.

Schnelldokumentation

Das Schnelldokumentations-Popup (Strg+Q) ist ein universelles Tool, das Ihnen weiterführende Informationen zum Codeelement unter dem Cursor bereitstellt. Standardmäßig zeigt CLion die Schnelldokumentation bei schwebendem Mauszeiger automatisch in einem Popup an. Je nachdem, für welches Element Sie es aufrufen, kann das Popup folgende Informationen enthalten:

Funktionssignatur.
Code-Dokumentation (entweder reguläre oder Doxygen-Kommentare).
Abgeleitete Typen (besonders wertvoll für modernen C++-Code, in dem oft auf explizite Typen verzichtet wird).
Typgrößen.
Makro-Ersetzungen als Verständnis- und Debugging-Hilfe für verschachtelte Makros.
Werte von konstanten Ausdrücken.
Enum-Werte als Ganzzahlen.