Inclusion de code en ligne

Les commandes suivantes sont utilisées pour rendre le code source sans formatage. Le code source commence sur une nouvelle ligne, rendue dans le code.

Note : Bien que la plupart de ces commandes servent à rendre le code C++, les commandes \snippet et \codeline sont préférables aux autres. Ces commandes permettent de remplacer les extraits de code C++ dans la documentation par des extraits de code équivalents pour d'autres langages Qt.

\code

Les commandes \code et \endcode contiennent un extrait de code source.

Note : La commande \c peut être utilisée pour de courts fragments de code à l'intérieur d'une phrase. La commande \code est destinée aux extraits de code plus longs. Elle rend le code textuellement dans un paragraphe séparé dans un élément html <pre>, et analyse l'extrait inclus, créant des liens vers tous les types connus dans le code.

Pour documenter des instructions en ligne de commande, des scripts shell ou tout contenu qui n'est pas dans un langage Qt reconnu par QDoc, utilisez plutôt \badcode.

Lors du traitement de la commande \code, QDoc supprime toute indentation commune aux blocs de code verbatim à l'intérieur d'un commentaire /*! ... */ avant d'ajouter l'indentation standard.

Note : Ceci ne s'applique pas au code cité en externe à l'aide de la commande \quotefromfile ou \quotefile.

/*!
    \code
        #include <QApplication>
        #include <QPushButton>

        int main(int argc, char *argv[])
        {
            ...
        }
    \endcode
*/

Les autres commandes QDoc sont désactivées dans \code.... \endcode, et le caractère spécial '\' est accepté et rendu comme le reste du code, sauf s'il est suivi d'un chiffre et que des paramètres ont été passés à \code.

Mise en évidence et liens automatiques

La commande \code tente d'analyser son contenu en tant que code d'un langage spécifique, tel que défini dans la variable de configuration du langage. Cela permet de mettre en évidence et de lier automatiquement les types détectés dans le code.

Exceptionnellement, depuis la version 6.4 de QDoc, lorsque la commande \code est utilisée dans une rubrique spécifique au QML, QDoc tente d'abord de reconnaître le code comme étant du QML ; pour les autres rubriques, la variable de configuration du langage a la priorité. Pour marquer explicitement l'extrait de code comme QML, utilisez plutôt la commande \qml.

Paramètres de l'extrait de code

Depuis la version 5.12 de QDoc, la commande \code accepte également des paramètres facultatifs. Les paramètres sont utiles pour injecter des chaînes simples dans l'extrait de code. Pour injecter une chaîne de caractères à un endroit précis du code, ajoutez une barre oblique inverse suivie d'un chiffre (1..8). Les chiffres correspondent à l'ordre de la liste d'arguments, où les arguments sont séparés par des espaces.

Par exemple :

/*!
    \code * hello
    /\1 \2 \1/
    \endcode
*/

Dans l'extrait ci-dessus, QDoc rend le mot hello entouré d'un commentaire de style C.

Intégration de code provenant de fichiers externes

Pour inclure des extraits de code provenant d'un fichier externe, utilisez les commandes \snippet et \codeline.

Voir aussi \c, \qml, \badcode, \quotefromfile, et language.

\Ncode malveillant

Similaires à \code, les commandes \badcode et \endcode contiennent du contenu qui est rendu verbatim dans un paragraphe séparé, mais aucune analyse ou création de lien automatique n'est effectuée. Le contenu est traité comme du texte brut.

Remplacez \code par cette commande lorsque vous documentez des instructions de ligne de commande, des scripts shell ou tout autre contenu qui n'est pas dans un langage Qt, mais qui doit quand même être stylisé de la même manière qu'un paragraphe \code.

Comme \code, \badcode accepte également des paramètres optionnels.

\qml

Les commandes \qml et \endqml contiennent un extrait de code source QML. Elles permettent de mettre en évidence la syntaxe des extraits de code QML. L'extrait joint doit être complet comme s'il s'agissait d'un fichier .qml valide. Si l'extrait est incomplet, QDoc émettra un avertissement et ignorera l'extrait.

/*!
    \qml
        import QtQuick 2.0

        Row {
            Rectangle {
                width: 100; height: 100
                color: "blue"
                transform: Translate { y: 20 }
            }
            Rectangle {
                width: 100; height: 100
                color: "red"
                transform: Translate { y: -20 }
            }
        }
    \endqml
*/

Comme la commande \code, \qml accepte des paramètres optionnels.

© 2025 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.