文档结构
文档结构命令用于将文档分成多个部分。QDoc支持四个级别的部分:\section1
、\section2
、\section3
和 \section4
。这些命令与传统的部分、子部分等对应。
部分命令
一般情况下,文档结构命令将其后的所有内容(直到第一个换行符)视为其参数。参数以单元标题的形式呈现。如果标题需要跨多行显示,确保每行(除了最后一行)都以反斜杠结尾。
在QDoc中,部分的级别总共有四个:\section1
、\section2
、\section3
和 \section4
。这些对应于传统的部分、子部分、子子部分和子子子部分。
部分单元有严格的顺序
section1 | section2 | section3 | section4
当使用部分时,第一个部分命令应该是 section1
。
/*! \section1 Basic Qt This is the first section. \section2 Getting Started This is the first subsection. \section3 Hello Qt This is the first subsubsection. \section3 Making Connections This is the second subsubsection. \section3 Using the Reference Documentation This is the third subsubsection. \section2 Creating Dialogs This is the second subsection. \section3 Subclassing QDialog This is the first subsubsection. ... \section1 Intermediate Qt This is the second section. \section2 Layout Management This is the second section's first subsection. \section3 Basic Layouts This is the first subsubsection. ... */
每个部分是文档中的一个逻辑单元。部分标题会出现在自动生成的目录表中,通常出现在页面的右上角。
\section1
\section1
命令开始一个新部分。
请参阅部分命令以了解不同部分单元、命令参数和渲染的说明。
\section2
\section2
命令开始一个新部分。
请参阅部分命令以了解不同部分单元、命令参数和渲染的说明。
\section3
\section3
命令开始一个新部分。
请参阅部分命令以了解不同部分单元、命令参数和渲染的说明。
\section4
\section4
命令开始一个新部分。
请参阅部分命令以了解不同部分单元、命令参数和渲染的说明。
© 2024 Qt公司有限公司。本文件中包含的文档贡献的版权归其各自的拥有者所有。本文件中提供的文档是根据自由软件基金会发布的GNU自由文档许可证版本1.3中的条款许可的。Qt及其 respective logo是芬兰乃至世界各地的Qt公司有限责任公司的商标。所有其他商标均为其各自拥有者的财产。