2014-01-28 3 views
0

Есть ли какой-либо инструмент или плагин для визуальной студии C++ для создания автоматической предварительной структуры комментариев doxygen, основанных на определении функции?Doxygen auto param generate

спасибо.

что-то вроде этого примера:

/** 
***************************************************************************************** 
* @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. **/ 
    ); 

Любой инструмент, который автоматически записывает параметры будут производить бесполезные документации кто-то другой должен заполнить в любом случае.

Вы можете установить WARN_NO_PARAMDOC = YES в свой файл doxygen, если вам нужен список параметров, которые не были документированы.

При этом вы можете попробовать Gostdoc, если у вас есть какое-то ограничение процесса, когда бессмысленные комментарии «лучше», чем никакие комментарии.

+0

Следует отметить, что встроенная документация упрощает упорядочивание данных при изменении параметров, чем документация в заголовке метода. –