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 | ||||
---|---|---|---|---|---|---|
單元格 row=1+2,col=1 | 單元格 row=1,col=2 | 單元格 row=1,col=3 | ||||
單元格 row=2+3,col=2 | 單元格 row=2,col=3 | |||||
單元格 row=3,col=1 | 單元格 row=3+4,col=3 | |||||
單元格 row=4,col=1+2 | ||||||
單元格 row=5,col=1 | 單元格 row=5,col=2+3 | |||||
單元格 row=6+7,col=1+2 | 單元格 row=6,col=3 | |||||
單元格 row=7,col=3 | ||||||
單元格 row=8,col=1 | 單元格 row=8,col=2
| 單元格 row=8,col=3
|
可以使用 \ref
命令並使用標題的 ID 作為標籤來引用表格的標題。