如果将注释分成多段，请避免在表的最后一列中出现换行符

Question

我正在用doxygen记录我的C / C ++代码。我想在一个表中收集（一长串）参数列表的文档：表格的每一行都应包含一小段代码，以便在处理参数的地方记录每个参数（例如，第一列参数名称，第二列参数说明/默认值等）。因此，需要将此长表的注释分成很多部分。

请考虑以下文档。第一个表具有“中断”，而第二个表则没有。

/// \file main.cpp 

/// \brief main function 
int main () { 
  /// <table> 
  /// <tr> <td> 1    <td> 2  

  // some code 

  /// <tr> <td> 3    <td> 4 
  /// </table> 
  /// <table> 
  /// <tr> <td> 1    <td> 2 
  /// <tr> <td> 3    <td> 4 
  /// </table> 
} 
在与此文件相同的目录（称为main.cpp）中，我运行doxygen -g cfg和doxygen cfg。这将创建文件html/main_8cpp.html（除其他外）。 doxygen版本是1.8.17。

第一个表的输出并不令人满意。拆分表的注释会导致意外的换行，并因此在最后一列中显示丑陋的条目。

我尝试用</td> </tr>手动结束表的行，但换行行为保持不变。可以避免这种行为吗？

如果我查看html源，则两个表的输出是不同的。

<p>main function </p>
<table class="doxtable">
<tr>
<td>1 </td><td><p class="starttd">2 <br  />
</p>
<p class="endtd"></p>
</td></tr>
<tr>
<td>3 </td><td>4 </td></tr>
</table>
<table class="doxtable">
<tr>
<td>1 </td><td>2 </td></tr>
<tr>
<td>3 </td><td>4 </td></tr>
</table>
问题出在<p class="starttd">2 <br /> </p>段（<p>标签，而不是<br>）。如果我删除它们，则换行符消失。

我正在用doxygen记录我的C / C ++代码。我想收集一个单一表中的（长）参数列表的文档：表的每一行都应具有一小段代码，以便...

Answer 1

评论有点长。