Question

目前我的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

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

E.g。在latex-generated pdf中，将生成一个表，其中包含一个参数类型（int）的方向（in）和名称（var1 / var2）。有一些方法可以让另一个表格单元格为0-500？

Answer 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 Manual: HTML Commands。

Doxygen记录可能的参数值

1 个答案: