텍스트 마크업
텍스트 서식 지정 명령어는 텍스트가 어떻게 표시되어야 하는지를 나타냅니다.
\a (매개변수 마커)
\a 명령어는 QDoc에 다음 단어가 형식 매개변수 이름임을 알립니다.
형식 매개변수가 문서화되지 않았거나 철자가 틀린 경우 경고가 표시되므로, 함수를 문서화할 때는 함수 설명에서 각 형식 매개변수의 이름을 \a 명령어 앞에 명시해야 합니다. 그러면 매개변수 이름이 이탤릭체로 표시됩니다.
형식 매개변수 이름은 중괄호로 묶을 수 있지만, 반드시 그래야 하는 것은 아닙니다.
\c (코드 폰트)
\c 명령어는 변수 이름, 사용자 정의 클래스 이름 및 C++ 키워드(예: int 및 for)를 코드 폰트로 표시하는 데 사용됩니다.
이 명령어는 인수를 고정폭 글꼴로 표시합니다. 코드 글꼴로 표시할 텍스트에 공백이 포함된 경우, 전체 텍스트를 중괄호로 묶어야 합니다:
\c 명령어는 인자 내에서 특수 문자 \ 을 허용하며, 이를 일반 문자로 렌더링합니다. 따라서 중첩된 명령어를 사용하려면 대신 텔라이프(\tt) 명령어를 사용해야 합니다.
\details (접기 가능)
\details 및 \enddetails 명령어는 숨김/표시 상태를 제어하는 <summary>을 가진 접을 수 있는 <details> 요소를 생성합니다.
HTML 출력을 생성할 때, \details 및 \enddetails 명령어를 사용하여 접을 수 있는 <details> HTML 요소를 생성하십시오. 이 명령어는 중괄호로 묶인 선택적 요약 문자열을 인수로 받습니다. 이 선택적 인수는 세부 정보에 표시될 제목을 지정합니다.
인수가 생략된 경우, QDoc은 요약 문자열로 "..."을 출력합니다.
예를 들어, 다음과 같은 입력을 할 경우:
/*!
\details {QDoc details}
\note You're looking at detailed information.
\enddetails
*/QDoc이 HTML을 생성하는 경우, 이러한 명령을 다음과 같이 변환합니다:
<details>
<summary>QDoc details</summary>
<div class="admonition note">
<p><b>Note: </b>You're looking at detailed information.</p>
</div>
</details>QDoc은 이를 다음과 같이 렌더링합니다:
QDoc 세부 정보
참고: 현재 상세 정보를 보고계십니다 .
다른 출력 형식의 경우, QDoc은 요약 문자열을 무시하고 내용을 일반 단락으로 생성합니다. 이 명령어는 Qt 6.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 파일에 있는 대로 모든 class 속성 값이 정의되어 있으면, 위의 예제는 다음과 같이 렌더링됩니다:
Qt 개발자 가이드
참조 \span.
\span
\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
*/변수Name 클래스는 style.css 파일 내의 한 절을 가리킵니다.
.variableName
{
font-family: courier;
color: blue
}위에서 보여준 variableName 절을 사용하면, 예제는 다음과 같이 렌더링됩니다:
복잡한 타입을 가진 전역 변수:
- globals.cpp 파일 14행의mutableComplex1
- globals.cpp 파일 15행의mutableComplex2
- globals.cpp 파일 16행의constComplex1
- globals.cpp 파일 17행의constComplex2
참고: span명령어는 새로운 단락을 시작하지 않습니다.
참조: \div.
\tm (상표)
\tm 명령어는 인수가 상표임을 나타냅니다. QDoc은 페이지를 생성할 때 인수가 처음 등장하는 위치에 상표 기호 `™`를 추가합니다.
프로젝트 구성에서 ` navigation.trademarkspage ` 변수는 상표 관련 문서가 포함된 페이지의 제목을 정의하는 데 사용됩니다.
navigation.trademarkspage = Trademarks이 변수가 설정된 경우, 상표 기호가 나타나는 각 위치마다 상표 페이지로 연결되는 링크가 생성됩니다.
참고: 섹션제목에서는 \tm 명령어가 무시되며, 해당 인수는 있는 그대로 표시됩니다.
참조 \section1 및 navigation.
\tt (텔레타이프 글꼴)
\tt 명령어는 인수를 고정폭 글꼴로 렌더링합니다. 이 명령어는 \c 명령어와 똑같이 동작하지만, \tt 는 인자 내에 QDoc 명령어를 중첩할 수 있다는 점이 다릅니다(예: \e, \b 및 \underline)을 인자 내에 중첩하여 사용할 수 있다는 점이 다릅니다.
/*!
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}().}
*/코드 폰트로 렌더링할 텍스트에 공백이 포함되어 있다면, 전체 텍스트를 중괄호로 묶으십시오.
참조 \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.
\underline
\underline 명령어는 인수를 밑줄이 그어진 형태로 표시합니다.
/*!
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은 이중 하이픈을 엔 대시로 렌더링합니다. 입력 내용을 그대로 표시하도록 설계된 QDoc 마크업 명령어(예: ` \c ` 명령어)는 이중 하이픈을 엔 대시 문자로 대체하지 않습니다. 예를 들면 다음과 같습니다:
/*!
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.
*/경고: 섹션 및 페이지 제목에 엔 대시를 사용하지마십시오 . 제목에 엔 대시와 같은 특수 문자가 포함되어 있으면 제목으로의 링크가 작동하지 않을 수 있습니다.
참조: --- (엠 대시).
--- (엠 대시)
QDoc은 세 개의 하이픈을 엠 대시로 변환합니다. 입력 내용을 그대로 표시하도록 설계된 QDoc 마크업 명령어(예: \c 명령어)는 세 개의 하이픈을 엠 대시 문자로 대체하지 않습니다. 예를 들어:
/*!
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 dash)를 위한 것입니다. 이를 통해 출력 시 하이픈 뒤에 엔 대시가 이어지는 것을 방지할 수 있습니다.
경고: 섹션 및 페이지 제목에는 엠 대시를 사용하지마십시오 . 제목에 엠 대시와 같은 특수 문자가 포함되어 있으면 제목으로의 링크가 작동하지 않을 수 있습니다.
참조: -- (엔 대시).
© 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.