Makros
Verwenden Sie die Makrovariable, um eigene einfache QDoc-Befehle zu erstellen.
Makros sind nützlich für:
- Das Einfügen von wiederkehrendem Text, wie z. B. formatierte Textausschnitte, in die Dokumentation.
- Das Einbinden von Informationen, wie z. B. Versionszeichenfolgen, aus dem Build-System in die Dokumentation.
- Die Verwaltung eines zentralen Speicherorts für Zeichenfolgen, die sich in Zukunft wahrscheinlich ändern werden, wie z. B. Produktnamen.
- Sicherstellen, dass ein Begriff oder Produktname konsistent verwendet wird.
- Die Gestaltung der generierten Dokumentation mithilfe von HTML- und DocBook-Elementen, wie erzwungene Zeilenumbrüche und Sonderzeichen.
- Verwendung von Tabulatoren, um beispielsweise Beispiele für Inhalte verschiedener Programmiersprachen, Betriebssysteme oder Tools darzustellen.
Globale Makros
Eine Liste vordefinierter globaler Makros, die Sie in allen Dokumentationsprojekten verwenden können, sowie deren aktuelle Werte finden Sie in den Dateien /qtbase/doc/global/macros.qdocconf und /qtbase/doc/global/htmltabs.qdocconf. Zu diesen Makros gehören unter anderem:
- CMake-Codeausschnitte
- HTML- und DocBook-Formatierung
- Produktnamen
- Produktversionen
- Inhalte mit Registerkarten
- Links zu YouTube-Inhalten
- Verschiedene Makros
Qt Online Installer kopiert die Makrodateien in Ihren Qt-Installationsordner, sodass Sie die Makros auch dann verwenden können, wenn Sie die Dokumentation mit QDoc aus einer installierten Qt-Version erstellen (im Gegensatz zur eigenständigen Erstellung von QDoc aus den Quelltexten).
Hinweis: Die Werte der globalen Makros können sich zwischen verschiedenen Qt-Versionen ändern, sodass die Makros je nach der von Ihnen zum Erstellen der Dokumentation verwendeten Qt-Version unterschiedlich erweitert werden können.
Makros hinzufügen
Sie können Makros für ein bestimmtes Dokumentationsprojekt in der .qdocconf-Datei des Projekts oder in jeder .qdocconf-Datei hinzufügen, die Sie darin einbinden. Wenn das Makro in mehr als einem Dokumentationsprojekt nützlich sein könnte, fügen Sie es der Datei mit den globalen Makros hinzu.
Weitere Informationen zur Makrosyntax und zu den Optionen finden Sie unter „makro“.
Verwendung von Makros
Sie können Makros auf dieselbe Weise verwenden wie die integrierten QDoc-Befehle in:
- Quellcode-Dateien, in Dokumentationskommentaren (.cpp, .qml)
- Dokumentationsquelldateien (.qdoc, .qdocinc)
Beispiel:
\QOI copies the macros files to your Qt installation folder.Veraltete Makros
Die globale Makrodatei enthält die folgenden veralteten Makros, um die Kompatibilität mit älteren Dokumentationssätzen zu gewährleisten.
| Nicht verwenden | Verwenden Sie |
|---|---|
| \gui | \uicontrol |
| \menu | \uicontrol |
| \param | \a |
| \return | Schreiben Sie „Returns “ oder „returns“. |
Siehe auch „makro “ und „Unbekanntes Makro“.
© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.
