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

Question

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

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

/**
 *****************************************************************************************
 *  @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 的描述之后。

这是一种耻辱，因为//!< style 比使用 @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 : '使用内联注释返回文档后的参数文档'，这是在 2005 年 9 月报告的，尚未修复。

因此，可悲的是，恐怕您的问题的答案是否可以定义顺序，以便将“参数”放在“返回”之前？几乎可以肯定是没有。

编辑

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