doxygen 函数参数文档 (//!< vs @param)

Question

如果我对函数参数使用“成员之后”文档，例如，在每个参数之后使用//!<，而不是标题中的@param，“参数”部分总是放在生成的“返回”之后输出文件。

是否可以定义顺序，使“参数”放在“返回”之前？

/**
 *****************************************************************************************
 *  @brief      Test API
 *
 *  @usage      This API can be called at any time
 *
 *  @return     0 if successful; or 1 if failed
 ****************************************************************************************/

int TestAPI(
    int argument1,       //!< first argument
    int argument2        //!< second argument
    );

Answer 1

我刚刚使用 Doxygen 1.7.5.1 试用了您的代码，并确认使用您的代码，输出中的参数列表位于 Return 的描述之后。

这很遗憾，因为//!< 样式比必须用@param 重新声明所有参数的名称要好得多：

/**
 *****************************************************************************************
 *  @brief      Test API
 *
 *  @usage      This API can be called at any time
 * 
 *  @param      argument1 first argument
 *  @param      argument2 second argument
 *
 *  @return     0 if successful; or 1 if failed
 ****************************************************************************************/

int TestAPI2(
    int argument1,
    int argument2
    );

我查看了Doxygen Bugzilla bug database，看看它是否是一个相对较新的错误（然后您可以尝试恢复到较旧的安装）。

相信您已经找到Doxygen Bug 316311: 'parameter documentation after return documentation by using inline cmets'，2005 年 9 月报告，尚未修复。

所以，遗憾的是，恐怕您的问题的答案是否可以定义顺序，以便将“参数”放在“返回”之前？几乎可以肯定。 p>

编辑

我刚刚向 Doxygen Bug 316311 添加了一条注释，要求将其更改为 Status=CONFIRMED。