Incluir código en línea
Los siguientes comandos se utilizan para mostrar el código fuente sin formato. El código fuente comienza en una nueva línea y se muestra tal cual en el código.
Nota: Aunque la mayoría de estos comandos sirven para mostrar código C++, el \snippet y \codeline son preferibles a los demás. Estos comandos permiten sustituir los fragmentos de código de C++ de la documentación por fragmentos equivalentes de otros lenguajes vinculados a Qt.
\code
Los comandos \code y \endcode enmarcan un fragmento de código fuente.
Nota: El \c se puede utilizar para fragmentos cortos de código dentro de una frase. El comando \code sirve para fragmentos de código más largos. Muestra el código tal cual en un párrafo independiente dentro de un elemento HTML <pre> y analiza el fragmento incluido, creando enlaces a cualquier tipo conocido que aparezca en el código.
Para documentar instrucciones de línea de comandos, scripts de shell o cualquier contenido que no esté escrito en un lenguaje Qt reconocido por QDoc, utiliza \badcode en su lugar.
Al procesar el comando « \code », QDoc elimina toda la sangría habitual de los bloques de código tal cual dentro de un comentario /*! ... */ antes de añadir la sangría estándar.
Nota: Esto no se aplica al código entre comillas externas que utiliza el \quotefromfile o \quotefile .
/*!
\code
#include <QApplication>
#include <QPushButton>
int main(int argc, char *argv[])
{
...
}
\endcode
*/El resto de comandos de QDoc están desactivados en \code... \endcode, y el carácter especial «\» se acepta y se representa como el resto del código, a menos que vaya seguido de un dígito y se hayan pasado parámetros a \code.
Resaltado y enlaces automáticos
Los comandos de \code intentan analizar su contenido como código de un lenguaje específico, tal y como se define en la variable de configuración de lenguaje. Esto proporciona resaltado y enlaces automáticos a los tipos detectados en el código.
Como excepción, desde la versión 6.4 de QDoc, cuando se utiliza el comando \code dentro de un tema específico de QML, QDoc intenta primero reconocer el código como QML; para otros temas, tiene prioridad la variable de configuración de lenguaje. Para marcar explícitamente el fragmento de código como QML, utilice en su lugar el \qml comando en su lugar.
A partir de la versión 6.11, se puede especificar un lenguaje como argumento opcional, sin distinción entre mayúsculas y minúsculas, en la misma línea que el comando ` \code `. Cuando se especifica, el lenguaje anula el lenguaje predeterminado y cualquier otro comportamiento específico del lenguaje descrito anteriormente. QDoc también define el lenguaje ` text `, de modo que los bloques de código se puedan mostrar sin ningún tipo de marcado ni resaltado.
Por ejemplo:
\code [text]
# This is an example of unmarked code.
implement MyModule;
include "sys.m";
sys: Sys;
\endcodeEsto puede resultar útil al citar un lenguaje que QDoc no es capaz de marcar.
Como alternativa, puedes especificar un lenguaje para un bloque de código que QDoc no reconozca incluyendo dicho lenguaje en la lista que contiene la variable de configuración `codelanguages`. Esto permite incluir metadatos en el HTML generado que otras herramientas pueden utilizar para resaltar la sintaxis del código.
Parámetros de fragmentos de código
Desde la versión 5.12 de QDoc, el comando « \code » también admite parámetros opcionales. Los parámetros resultan útiles para insertar cadenas de texto sencillas en el fragmento de código. Para insertar una cadena en una ubicación concreta del fragmento, añade una barra invertida seguida de un dígito (del 1 al 8). Los dígitos se corresponden con el orden de la lista de argumentos, en la que los argumentos están separados por espacios y siguen a cualquier argumento de idioma opcional.
Por ejemplo:
/*!
\code * hello
/\1 \2 \1/
\endcode
*/En el fragmento anterior, QDoc muestra la palabra «hello» entre comentarios al estilo de C.
Incluir código de archivos externos
Para incluir fragmentos de código de un archivo externo, utiliza la etiqueta \snippet y \codeline .
Véase también \c, \qml, \badcode, \quotefromfile, y el idioma.
\badcode
Al igual que \code, los comandos \badcode y \endcode encierran contenido que se muestra tal cual en un párrafo aparte, pero no se lleva a cabo ningún análisis sintáctico ni se crean enlaces automáticamente. En su lugar, el contenido se trata como texto sin formato.
Sustituye \code por este comando al documentar instrucciones de línea de comandos, scripts de shell o cualquier otro contenido que no esté en un lenguaje de Qt XML, pero que deba tener un estilo similar al de un párrafo \code.
Al igual que \code, \badcode también admite parámetros opcionales.
\qml
Los comandos \qml y \endqml enmarcan un fragmento de código fuente QML. Utilízalos para resaltar correctamente la sintaxis de los fragmentos de código QML. El fragmento enmarcado debe estar completo, como si se tratara de un archivo .qml válido. Si el fragmento está incompleto, QDoc emitirá una advertencia e ignorará el fragmento.
/*!
\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
*/Al igual que el \code , el comando \qml admite parámetros opcionales.
© 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.