2014-01-28 59 views
0

是否有任何工具或插件的Visual Studio C++生成基於函數的定義的doxygen註釋的自動預結構?Doxygen auto param生成

謝謝。

這樣的例子:

/** 
***************************************************************************************** 
* @brief  
* 
* @usage  
* 
* @param  
* @param  
* 
* @return  
****************************************************************************************/ 

int TestAPI2(
    int argument1, 
    int argument2 
    ); 
+0

你可以使用[Visual Assist X](http://www.wholetomato.com/)(注意它不是免費的)。 – Angew

回答

0

我建議,而不是你的參數

int TestAPI2(
    int argument1, /**< does this **/ 
    int argument2 /**< does that, should never be a prime number, 
         and I keep wanting to go on and on about it. **/ 
    ); 

任何工具,它會自動記錄的參數會產生無用的文件有其他人來填補在線文檔以任何方式。

如果您需要一個尚未記錄的參數列表,您可以在doxygen文件中設置WARN_NO_PARAMDOC = YES

也就是說,如果您有一些流程限制,其中無意義的評論比沒有評論「更好」,那麼您可以嘗試Gostdoc

+0

值得注意的是,內聯文檔可以在參數更改時比保存方法標題中的文檔更輕鬆地保持內容順序。 –