텍스트 마크업

텍스트 서식 지정 명령은 텍스트가 렌더링되는 방식을 나타냅니다.

\a(매개변수 마커)

a 명령은 다음 단어가 공식적인 매개변수 이름임을 QDoc에 알려줍니다.

공식 매개변수가 문서화되지 않았거나 철자가 틀린 경우 경고가 표시되므로 함수를 문서화할 때는 함수 설명에 각 공식 매개변수를 이름별로 언급하고 그 앞에 \a 명령을 붙여야 합니다. 그러면 매개변수 이름이 이탤릭체로 렌더링됩니다.

공식 매개변수 이름은 중괄호로 묶을 수 있지만 반드시 그렇게 할 필요는 없습니다.

\c(코드 글꼴)

c 명령은 변수 이름, 사용자 정의 클래스 이름 및 C++ 키워드(예: intfor)를 코드 글꼴로 렌더링하는 데 사용됩니다.

이 명령은 모노스페이스 글꼴을 사용하여 인수를 렌더링합니다. 코드 글꼴로 렌더링할 텍스트에 공백이 포함된 경우 전체 텍스트를 중괄호로 묶어야 합니다:

\c {QLineEdit::QLineEdit(const QString &contents, QWidget *parent) : QWidget(parent)}

c 명령은 인자 안에 특수 문자 \ 를 허용하여 일반 문자로 렌더링합니다. 따라서 중첩된 명령을 사용하려면 텔레타입(\tt) 명령을 대신 사용해야 합니다.

tt 및 \code도 참조하세요.

\세부정보(접을 수 있음)

details 및 \enddetails 명령은 숨김/보이기 상태를 제어하기 위해 <summary>가 포함된 접을 수 있는 <details> 요소를 생성합니다.

HTML 출력을 생성할 때는 \details 및 \enddetails 명령을 사용하여 접을 수 있는 <details> HTML 요소를 생성합니다. 이 명령은 중괄호로 묶인 선택적 요약 문자열을 받습니다. 이 선택적 인수는 세부 정보에 대한 표시되는 제목을 지정합니다.

예를 들어 다음과 같이 입력합니다:

/*!
    \details {QDoc details}
      \note You're looking at detailed information.
    \enddetails
*/

QDoc이 HTML을 생성하는 경우 이 명령은 다음과 같이 번역됩니다:

<summary>QDoc details</summary><div class="admonition note"><p><b>Note: </b>You're looking at detailed information.</p></div>

QDoc은 이를 다음과 같이 렌더링합니다:

QDoc 세부 정보

참고: 자세한 정보를 보고 있습니다.

다른 출력 형식의 경우 QDoc은 요약 문자열을 무시하고 내용을 일반 단락으로 생성합니다. 이 명령은 Qt6.6에서 QDoc에 도입되었습니다.

\div

div 및 \enddiv 명령은 특수 서식 속성을 적용해야 하는 크고 작은 텍스트 블록(다른 QDoc 명령이 포함될 수 있음)을 구분합니다.

인수는 아래 표시된 QDoc 설명에서와 같이 중괄호로 묶어서 제공해야 합니다. 인수는 해석되지는 않지만 QDoc에서 출력되는 태그의 속성으로 사용됩니다.

예를 들어 인라인 이미지를 렌더링하여 현재 텍스트 블록의 오른쪽에 띄우려고 할 수 있습니다:

/*!
    \div {class="float-right"}
        \inlineimage qml-column.png
    \enddiv
*/

QDoc이 HTML을 생성하는 경우 이 명령은 다음과 같이 번역됩니다:

<div class="float-right"><p><img src="images/qml-column.png" /></p></div>

HTML의 경우, 속성 값 float-right는 이 경우 style.css 파일의 절을 참조합니다:

div.float-right
{
   float: right; margin-left: 2em
}

참고: \div 명령은 중첩될 수 있습니다.

아래에서 Qt 4.7용 index.html을 생성하는 데 사용되는 index.qdoc 파일에서 가져온 예제를 확인할 수 있습니다:

\div {class="indexbox guide"}
    \div {class="heading"}
        Qt Developer Guide
\enddiv
    \div {class="indexboxcont indexboxbar"}
        \div {class="section indexIcon"} \emptyspan
        \enddiv
        \div {class="section"}
            Qt is a cross-platform application and UI
            framework. Using Qt, you can write web-enabled
            applications once and deploy them across desktop,
            mobile and embedded operating systems without
            rewriting the source code.
        \enddiv
        \div {class="section sectionlist"}
            \list
               \li \l{Getting Started}
               \li \l{Installation} {Installation}
               \li \l{how-to-learn-qt.html} {How to learn Qt}
               \li \l{tutorials.html} {Tutorials}
               \li \l{Qt Examples} {Examples}
               \li \l{qt4-7-intro.html} {What's new in Qt 4.7}
            \endlist
        \enddiv
    \enddiv
\enddiv

모든 클래스 속성 값이 Qt 문서를 렌더링하는 데 사용되는 style.css 파일에 그대로 정의되어 있으면 위의 예제는 다음과 같이 렌더링됩니다:

Qt 개발자 가이드

Qt는 크로스 플랫폼 애플리케이션 및 UI 프레임워크입니다. Qt를 사용하면 소스 코드를 다시 작성하지 않고도 웹 지원 애플리케이션을 한 번 작성하여 데스크톱, 모바일 및 임베디드 운영 체제 전반에 배포할 수 있습니다.

  • 시작하기
  • 설치
  • Qt를 배우는 방법
  • 튜토리얼
  • 예제
  • Qt 4.7의 새로운 기능

참조하십시오.

\span

스팬 명령은 작은 텍스트 블록에 특수 서식을 적용합니다.

아래 QDoc 주석에 표시된 것처럼 두 개의 인수를 제공해야 하며, 각 인수는 중괄호로 묶어야 합니다. 첫 번째 인수는 해석되지 않지만 QDoc에서 출력되는 태그의 서식 지정 속성을 지정합니다. 두 번째 인수는 특수 서식 속성을 사용하여 렌더링할 텍스트입니다.

예를 들어 숫자 목록에서 각 요소의 첫 번째 단어를 파란색으로 렌더링하고 싶을 수 있습니다.

/*!
    Global variables with complex types:
\list 1
        \li \span {class="variableName"} {mutableComplex1} in globals.cpp at line 14
        \li \span {class="variableName"} {mutableComplex2} in globals.cpp at line 15
        \li \span {class="variableName"} {constComplex1} in globals.cpp at line 16
        \li \span {class="variableName"} {constComplex2} in globals.cpp at line 17
    \endlist
*/

variableName 클래스는 style.css의 절을 참조합니다.

.variableName
{
    font-family: courier;
color: blue
}

위에 표시된 variableName 절을 사용하면 예제는 다음과 같이 렌더링됩니다:

복잡한 유형을 가진 전역 변수:

  1. globals.cpp의 14줄에 있는mutableComplex1
  2. globals.cpp의 15줄에 있는mutableComplex2
  3. globals.cpp의 16행의constComplex1
  4. globals.cpp의 17행의constComplex2

참고: span 명령은 새 단락을 시작하지 않습니다.

div를 참조하세요.

\tm(상표)

tm 명령은 인수가 상표임을 나타냅니다. QDoc은 페이지를 생성할 때 인수의 첫 번째 항목에 상표 기호 `™`을 추가합니다.

프로젝트 구성에서 navigation.trademarkspage 변수는 상표 관련 문서가 포함된 페이지의 제목을 정의하는 데 사용됩니다.

navigation.trademarkspage = Trademarks

이 변수를 설정하면 상표 기호가 나타날 때마다 상표 페이지로 연결됩니다.

참고: 섹션 제목에서 \tm 명령은 무시되고 해당 인수가 그대로 렌더링됩니다.

섹션1navigation.

\TT(텔레타이프 글꼴)

tt 명령은 인수를 모노스페이스 글꼴로 렌더링합니다. 이 명령은 \c 명령과 동일하게 동작하지만 \tt는 인수 내에 QDoc 명령을 중첩할 수 있습니다(예: \e, \b\밑줄).

/*!
    After having populated the main container with
    child widgets, \c setupUi() scans the main container's list of
    slots for names with the form
    \tt{on_\e{objectName}_\e{signalName}().}
*/

코드 글꼴로 렌더링할 텍스트에 공백이 포함되어 있으면 전체 텍스트를 중괄호로 묶습니다.

\tt {QLineEdit::QLineEdit(const QString &contents, QWidget *parent) :QWidget(parent)}

c도 참조하세요.

\b

b 명령은 인수를 굵은 글꼴로 렌더링합니다. 이 명령은 예전에는 \bold라고 불렸습니다.

/*!
    This is regular text; \b {this text is
    rendered using the \\b command}.
*/

\br

br 명령은 줄 바꿈을 강제합니다.

\e(강조, 이탤릭체)

e 명령은 인수를 특수 글꼴(일반적으로 이탤릭체)로 렌더링합니다. 이 명령은 예전에는 \i라고 불렸지만 지금은 더 이상 사용되지 않습니다.

인수에 공백이나 기타 구두점이 포함된 경우 인수를 중괄호로 묶어야 합니다.

/*!
    Here, we render \e {a few words} in italics.
*/

공백이 포함된 인수 내에서 다른 QDoc 명령을 사용하려면 항상 인수를 중괄호로 묶어야 합니다. 그러나 QDoc은 괄호를 계산할 수 있을 만큼 똑똑하므로 이와 같은 경우에는 중괄호가 필요하지 않습니다:

/*!
    An argument can sometimes contain whitespaces,
    for example: \e QPushButton(tr("A Brand New Button"))
*/

마지막으로, 후행 구두점은 인수에 포함되지 않으며 "'s"도 포함되지 않습니다.

\sub

sub 명령은 더 작은 글꼴을 사용하여 인수를 일반 텍스트의 기준선보다 낮게 렌더링합니다.

/*!
    Definition (Range): Consider the sequence
    {x\sub n}\sub {n > 1} . The set

    {x\sub 2, x\sub 3, x\sub 4, ...} = {x\sub n ; n = 2, 3, 4, ...}

    is called the range of the sequence.
*/

인자에 공백이나 기타 구두점이 포함된 경우 인수를 중괄호로 묶습니다.

\sup

sup 명령은 인수를 더 작은 글꼴을 사용하여 일반 텍스트의 기준선보다 높게 렌더링합니다.

/*!
    The series

    1 + a + a\sup 2 + a\sup 3 + a\sup 4 + ...

    is called the \i {geometric series}.
*/

인자에 공백이나 기타 구두점이 포함된 경우 인수를 중괄호로 묶습니다.

\uicontrol

uicontrol 명령은 콘텐츠를 UI 컨트롤 요소에 사용되는 것으로 표시하는 데 사용됩니다. HTML을 사용하는 경우 출력은 굵게 렌더링됩니다.

b도 참조하십시오.

\밑줄

밑줄 명령은 인수를 밑줄로 표시합니다.

/*!
    The \underline {F}ile menu gives the users the possibility
    to edit an existing file, or save a new or modified
    file, and exit the application.
*/

인수에 공백이나 기타 문장 부호가 포함된 경우 인수를 중괄호로 묶습니다.

\\(이중 백슬래시)

시퀀스 \\는 단일 백슬래시로 확장됩니다.

QDoc 명령은 항상 백슬래시 하나로 시작합니다. 텍스트에 백슬래시 하나를 표시하려면 백슬래시 두 개를 입력해야 합니다. 백슬래시 두 개를 표시하려면 백슬래시 네 개를 입력해야 합니다.

/*!
    The \\\\ command is useful if you want a
    backslash to appear verbatim, for example,
    writing C:\\windows\\home\\.
*/

그러나 텍스트를 모노스페이스 글꼴로도 표시하려면 백슬래시를 다른 문자로 허용하고 렌더링하는 \c 명령을 대신 사용할 수 있습니다. 예를 들어

/*!
    The \\c command is useful if you want a
    backslash to appear verbatim, and the word
    that contains it written in a monospace font,
    like this: \c {C:\windows\home\}.
*/

-- (엔 대시)

QDoc은 이중 하이픈을 en 대시로 렌더링합니다. c 명령과 같이 입력 내용을 그대로 표시하도록 설계된 QDoc 마크업 명령은 이중 하이픈을 en 대시 문자로 바꾸지 않습니다. 예를 들어

/*!
    The \\c command -- useful if you want text in a monospace font --
    is well documented.
*/

그러나 다른 명령은 QDoc이 예상대로 출력을 렌더링하기 위해 하이픈을 이스케이프해야 할 수 있습니다. 예를 들어

/*!
    This \l {endash-sequence}{link to the -- (endash) sequence}
    isn't escaped and QDoc therefore renders an endash in the link
    text. However, the escaped
    \l {endash-sequence}{link to the \-- (endash) sequence}
    renders both hyphens as intended.
*/

(em 대시)도 참조하세요.

--- (em 대시)

QDoc은 트리플 하이픈을 en 대시로 렌더링합니다. c 명령과 같이 입력 내용을 그대로 표시하도록 설계된 QDoc 마크업 명령은 트리플 하이픈을 en 대시 문자로 바꾸지 않습니다. 예를 들어

/*!
    The \\c command---useful when you want text to be rendered
    verbatim---is well documented.
*/

그러나 다른 명령은 QDoc이 예상대로 출력을 렌더링하기 위해 하이픈을 이스케이프해야 할 수도 있습니다. 예를 들어

/*!
    This \l {emdash-sequence}{link to the --- (emdash) sequence}
    isn't escaped and QDoc therefore renders an emdash in the link
    text. However, the escaped
    \l {emdash-sequence}{link to the -\-- (emdash) sequence}
    renders both hyphens as intended.
*/

참고: 이 예제에서 이스케이프된 제어 시퀀스는 en 대시를 위한 것입니다. 이렇게 하면 출력에서 하이픈 뒤에 en 대시가 나오는 것을 방지할 수 있습니다.

(en 대시)도 참조하세요.

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