Мы управляем библиотекой C ++ / C # и заметили, что многие классы и функции остались недокументированными.
Мы подумали о написании сценария, который будет анализировать код для поиска недокументированных классов и методов для получения списка недокументированных классов / методов / функций.
Мы также хотели бы, чтобы скрипт поместил теги dOxygen на место для документации, где они отсутствуют. т.е. если найден такой фрагмент кода:
bool Myclass:undocumentedMethod(int a);
Это будет заменено на
/// \brief <DESCRIPTION>
/// \param a <DESCRIPTION>
/// \return bool <DESCRIBE RETURN VALUE>
bool Myclass:undocumentedMethod(int a);
Конечно, если в будущем у функции будет автоматически сгенерированный заголовок документации, но никто не прикоснется к заголовку, он все равно будет указан как недокументированный в отчете.
Какой язык сценариев вы бы использовали для разработки такого инструмента?
Anthony