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你的代碼，並確認你的代碼，在輸出參數列表來返回的描述後。

這是一個恥辱，因爲//!<風格比不必重新狀態下所有的參數名稱與@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，要求它改變到狀態=確認。