코드 인라인 포함

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

\code

\code 및 \endcode 명령은 소스 코드 스니펫을 둘러싸고 있습니다.

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

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

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

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

다른 QDoc 명령은 \code... 내에서 비활성화됩니다. \endcode 와 같이 특수 문자 '\'가 뒤에 숫자가 없고 매개 변수가 \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에 마크업 기능이 없는 언어를 인용할 때 유용할 수 있습니다.

또는 codelanguages 구성 변수가 보유한 목록에 언어를 포함하여 QDoc이 인식하지 못하는 코드 블록의 언어를 지정할 수 있습니다. 이렇게 하면 다른 도구에서 코드를 구문 강조 표시하는 데 사용할 수 있는 메타데이터가 생성된 HTML에 포함될 수 있습니다.

코드 조각 매개변수

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

예를 들어

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

위 코드 조각의 경우, QDoc은 헬로라는 단어를 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
*/

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