코드 인라인 포함

다음 명령은 서식을 지정하지 않고 소스 코드를 렌더링하는 데 사용됩니다. 소스 코드는 코드에서 렌더링된 새 줄에서 시작됩니다.

\코드

code 및 \endcode 명령은 소스 코드 스니펫을 묶습니다.

명령줄 지침, 셸 스크립트 또는 QDoc에서 인식하지 못하는 Qt 언어로 된 콘텐츠를 문서화하려면 \badcode를 대신 사용합니다.

code 명령을 처리할 때 QDoc은 표준 들여쓰기를 추가하기 전에 /*! ... */ 주석 내의 축어 코드 블록에 공통적으로 적용되는 모든 들여쓰기를 제거합니다.

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

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

다른 QDoc 명령은 \code... \끝코드에서는 특수 문자 '\'가 숫자가 뒤에 오고 매개 변수가 \code로 전달되지 않는 한 나머지 코드와 마찬가지로 허용되고 렌더링됩니다.

강조 표시 및 자동 링크

code 명령은 언어 구성 변수에 정의된 대로 해당 내용을 특정 언어의 코드로 구문 분석하려고 시도합니다. 이렇게 하면 코드에서 감지된 유형에 대한 강조 표시 및 자동 링크가 제공됩니다.

QDoc 버전 6.4부터 예외적으로, QML 관련 주제 내에서 \code 명령이 사용되는 경우 QDoc은 먼저 코드를 QML로 인식하려고 시도하고, 다른 주제에서는 언어 구성 변수가 우선합니다. 코드 조각을 QML로 명시적으로 표시하려면 \qml 명령을 대신 사용합니다.

코드 조각 매개변수

QDoc 버전 5.12부터 \code 명령은 선택적 매개변수도 허용합니다. 매개 변수는 코드 조각에 간단한 문자열을 삽입할 때 유용합니다. 코드 조각의 특정 위치에 문자열을 삽입하려면 백슬래시 뒤에 숫자(1..8)를 추가합니다. 숫자는 인수가 공백으로 구분되는 인수 목록의 순서와 일치합니다.

예를 들어

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

위 코드 조각의 경우, QDoc은 헬로라는 단어를 C 스타일 주석으로 묶어 렌더링합니다.

외부 파일에서 코드 포함

외부 파일의 코드 조각을 포함하려면 \스니펫 및 \코드라인 명령을 사용합니다.

c, \qml, \badcode, \quotefromfile 및 언어도 참조하세요.

\badcode

code와 유사하게 \badcode 및 \endcode 명령은 렌더링되는 콘텐츠를 별도의 단락으로 묶지만 구문 분석이나 자동 링크 생성이 수행되지 않습니다. 대신 콘텐츠는 일반 텍스트로 처리됩니다.

명령줄 지침, 셸 스크립트 또는 Qt 언어가 아니지만 여전히 \code 단락과 비슷한 스타일을 지정해야 하는 기타 콘텐츠를 문서화할 때는 이 명령으로 \code를 대체하세요.

code와 마찬가지로 \badcode는 선택적 매개변수도 허용합니다.

\qml

qml 및 \endqml 명령은 QML 소스 코드의 스니펫을 묶습니다. QML 코드 스니펫의 적절한 구문 강조 표시를 위해 사용합니다. 동봉된 코드 조각은 유효한 .qml 파일인 것처럼 완전해야 합니다. 코드 조각이 불완전하면 QDoc은 경고를 표시하고 해당 코드 조각을 무시합니다.

/*!
    \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
*/

코드 명령과 마찬가지로 \qml은 선택적 매개 변수를 허용합니다.