2

目前我的 C 代码函数声明记录如下

/** Some fubar function
 *@param[in]    val1    the first input variable
 *@param[in]    val2    the second input variable
 */
void foo (int val1, int val2);

但是说参数只能排除一定范围内的数字，例如0-500

除了作为参数描述的一部分之外，是否可以将其记录下来？也许这样它会在生成的文档中单独显示？

例如，在乳胶生成的 pdf 中，将生成一个表格，其中包含参数类型 (int)、方向 (in) 和名称 (var1/var2) 的单元格。有什么方法可以让另一个表格单元格包含 0-500？

4

1 回答 1

1

您最好的选择可能是详细信息部分中的表格。Doxygen 支持文档中的 HTML 命令，PDF 中生成的表格看起来不错。

/**
 * @brief Some fubar function
 * @param[in]    val1    the first input variable
 * @param[in]    val2    the second input variable
 *
 * <TABLE>
 * <TR><TD>Type</TD><TD>Direction</TD><TD>Name</TD><TD>Value Range</TD></TR>
 * <TR><TD>int</TD><TD>in</TD><TD>val1</TD><TD>0-500</TD></TR>
 * <TR><TD>int</TD><TD>in</TD><TD>val2</TD><TD>1-1000</TD></TR>
 * </TABLE>
 */
 void foo(int val1, int val2) {}

问题是它对我来说看起来很多余。也许将表限制为参数名称和预期值会更好看。

有关 doxygen 支持的 HTML 集，请参阅Doxygen 手册：HTML 命令。

于 2013-05-15T02:48:54.920 回答