Нужно написать скрипт, работающий под Win32, чтобы автоматически размещать теги для документации C ++ / C # - PullRequest
0 голосов
/ 15 декабря 2009

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

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

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

bool Myclass:undocumentedMethod(int a);

Это будет заменено на

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

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

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

Anthony

Ответы [ 2 ]

2 голосов
/ 15 декабря 2009

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

1 голос
/ 15 декабря 2009

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

...