코드 인라인 포함

다음 명령어는 서식 없이 소스 코드를 표시하는 데 사용됩니다. 소스 코드는 새 줄에서 시작되며, 코드 내에 그대로 표시됩니다.

\code

\code 및 \endcode 명령어는 소스 코드 스니펫을 감싸는 데 사용됩니다.

명령줄 지침, 셸 스크립트 또는 QDoc이 인식하는 Qt 언어가 아닌 콘텐츠를 문서화할 때는 \badcode 를 대신 사용하십시오.

\code 명령어를 처리할 때, QDoc은 /*! ... */ 주석 내의 원문 코드 블록에 일반적으로 적용되는 모든 들여쓰기를 제거한 후, 표준 들여쓰기를 추가합니다.

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

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

\code... \endcode 내에서는 다른 QDoc 명령어가 비활성화되며, 특수 문자 '\'는 그 뒤에 숫자가 따르지 않고 \code 에 매개변수가 전달되지 않은 경우, 나머지 코드와 마찬가지로 인식 및 렌더링됩니다.

하이라이트 및 자동 링크

\code 명령어는 언어 구성 변수에 정의된 대로 해당 내용을 특정 언어의 코드로 파싱하려고 시도합니다. 이를 통해 코드에서 감지된 유형에 대한 강조 표시 및 자동 링크 기능이 제공됩니다.

QDoc 버전 6.4부터는 예외적으로, QML 전용 주제 내에서 \code 명령을 사용할 경우 QDoc은 먼저 해당 코드를 QML로 인식하려고 시도합니다. 그 외의 주제에 대해서는 언어 구성 변수가 우선 적용됩니다. 코드 스니펫을 명시적으로 QML로 표시하려면 대신 \qml 명령을 대신 사용하십시오.

버전 6.11부터는 \code 명령어와 같은 줄에 대소문자를 구분하지 않는 선택적 인수로 언어를 지정할 수 있습니다. 언어가 지정되면, 해당 언어가 기본 언어 및 위에서 설명한 기타 언어별 동작을 재정의합니다. 또한 QDoc은 text 언어를 정의하여, 코드 블록이 마크업이나 강조 표시 없이 표시되도록 합니다.

예를 들어:

\code [text]
    # This is an example of unmarked code.
    implement MyModule;
    include "sys.m";
    sys: Sys;
\endcode

이는 QDoc이 마크업을 적용할 수 없는 언어를 인용할 때 유용할 수 있습니다.

또는, QDoc이 인식하지 못하는 코드 블록의 언어를 ` codelanguages ` 구성 변수가 관리하는 목록에 포함시켜 지정할 수도 있습니다. 이렇게 하면 생성된 HTML에 메타데이터가 포함되게 되어, 다른 도구에서 코드의 구문 강조에 이를 활용할 수 있습니다.

코드 스니펫 매개변수

QDoc 버전 5.12부터 ` \code ` 명령어는 선택적 매개변수도 지원합니다. 매개변수는 코드 스니펫에 간단한 문자열을 삽입하는 데 유용합니다. 스니펫의 특정 위치에 문자열을 삽입하려면 백슬래시 뒤에 숫자(1~8)를 추가하십시오. 이 숫자는 인자 목록의 순서와 일치하며, 인자들은 공백으로 구분되고 선택적인 언어 인자 뒤에 나열됩니다.

예를 들어:

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

위의 코드 조각의 경우, QDoc은 'hello'라는 단어를 C 스타일 주석으로 감싸서 표시합니다.

외부 파일의 코드 포함

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

참조: \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
*/

xml-ph-0000@deepl.internal \code 명령과 마찬가지로, \qml 도 선택적 매개변수를 지원합니다.