Генерация Doxygen автоматически
Есть ли какой-нибудь инструмент или плагин для Visual Studio C++ для генерации автоматической предварительной структуры комментариев Doxygen, основанных на определении функции?
Спасибо.
что-то вроде этого примера:
/**
*****************************************************************************************
* @brief
*
* @usage
*
* @param
* @param
*
* @return
****************************************************************************************/
int TestAPI2(
int argument1,
int argument2
);
1 ответ
Решение
Я бы посоветовал вам вместо этого документировать документ в соответствии с параметрами
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, если у вас есть некоторые ограничения процесса, где бессмысленные комментарии "лучше", чем никаких комментариев.