0

Мы управляем библиотекой C++/C#, и мы заметили, что многие классы и функции остались недокументированными.Необходимо написать сценарий, работающий под Win32, чтобы автоматически разместить теги для документации. C++/C#

Мы подумали о написании сценария, который будет анализировать код для поиска недокументированных классов и метода для создания списка недокументированных классов/методов/функций.

Мы также хотели бы, чтобы сценарий помещал теги dOxygen для документации там, где их нет. т.е. если такой кусок кода найден:

bool Myclass:undocumentedMethod(int a); 

Было бы заменить

/// \brief <DESCRIPTION> 
/// \param a <DESCRIPTION> 
/// \return bool <DESCRIBE RETURN VALUE> 
bool Myclass:undocumentedMethod(int a); 

Конечно, если функция в будущем автоматически сгенерированный заголовок документации, но никто не трогал заголовок он будет по-прежнему сообщается как недокументированное в отчете.

Какой язык скриптинга вы бы использовали для разработки такого инструмента?

Anthony

ответ

1

Вы можете взглянуть на http://submain.com/GhostDoc/, чтобы вставить документы с помощью горячей клавиши или мыши. Разработка подобной надстройки может быть выполнена так же, как GhostDoc, начиная с проекта шаблона надстройки Studio.

2

Вы пробовали Perl?

+0

Спасибо за ваш ответ, я не сделал, я попробую. – BlueTrin