Doxygen 支持两种在文档中添加表格的方法。
最简单的方法是使用 Markdown 格式,如Markdown 扩展部分中的表格所示。
尽管这种格式易于使用和阅读,但也相当有限。它仅支持简单的单元格网格,并且每个单元格仅为单行纯文本。
对于更复杂的表格,可以使用 HTML 语法。Doxygen 将处理这些表格,并将其转换为各种输出格式(至少对于支持表格的格式,如 HTML 和 )。
请注意,表格至少应包含 1 行 (<tr>
),并且如果使用了 <caption>
,则 <caption>
应位于第一行之前。
这是一个复杂表格的示例
<table> <caption id="multi_row">Complex table</caption> <tr><th>Column 1 <th>Column 2 <th>Column 3 <tr><td rowspan="2">cell row=1+2,col=1<td>cell row=1,col=2<td>cell row=1,col=3 <tr><td rowspan="2">cell row=2+3,col=2 <td>cell row=2,col=3 <tr><td>cell row=3,col=1 <td rowspan="2">cell row=3+4,col=3 <tr><td colspan="2">cell row=4,col=1+2 <tr><td>cell row=5,col=1 <td colspan="2">cell row=5,col=2+3 <tr><td colspan="2" rowspan="2">cell row=6+7,col=1+2 <td>cell row=6,col=3 <tr> <td>cell row=7,col=3 <tr><td>cell row=8,col=1 <td>cell row=8,col=2\n <table> <tr><td>Inner cell row=1,col=1<td>Inner cell row=1,col=2 <tr><td>Inner cell row=2,col=1<td>Inner cell row=2,col=2 </table> <td>cell row=8,col=3 <ul> <li>Item 1 <li>Item 2 </ul> </table>
它有一个标题、表格标题、各种行和列跨度、作为其中一个单元格的嵌套表格,以及另一个单元格中的项目列表。
请注意,在上面的示例中省略了结束标签(如 </td>
)。这是允许的,并且在 HTML 输出中,Doxygen 将再次添加结束标签。
输出结果如下
第 1 列 | 第 2 列 | 第 3 列 | ||||
---|---|---|---|---|---|---|
单元格 行=1+2,列=1 | 单元格 行=1,列=2 | 单元格 行=1,列=3 | ||||
单元格 行=2+3,列=2 | 单元格 行=2,列=3 | |||||
单元格 行=3,列=1 | 单元格 行=3+4,列=3 | |||||
单元格 行=4,列=1+2 | ||||||
单元格 行=5,列=1 | 单元格 行=5,列=2+3 | |||||
单元格 行=6+7,列=1+2 | 单元格 行=6,列=3 | |||||
单元格 行=7,列=3 | ||||||
单元格 行=8,列=1 | 单元格 行=8,列=2
| 单元格 行=8,列=3
|
可以使用 \ref 并使用标题的 ID 作为标签来引用表格的标题。