Doxygen для процедурных программ - PullRequest
2 голосов
/ 19 июля 2010

У меня есть несколько больших, в основном процедурных кодов, которые должны быть хорошо документированы. Обычно это предполагает многократное использование ряда функций, которые должны выполняться в определенном порядке.

Doxygen - отличный продукт, но он, похоже, очень ориентирован на документирование ООП-кодов. У кого-нибудь есть какие-нибудь советы о том, как использовать doxygen естественным образом для документирования процедурной работы?

1 Ответ

2 голосов
/ 19 июля 2010

В ООП нет ничего общего с тем, как работает кислород. Он просто может извлечь больше информации о ОО-коде, потому что в нем есть больше информации (например, графики наследования).

Мы используем doxygen для простого кода на C, и он работает так же хорошо, за исключением информации, которую простой C не предоставляет по сравнению с C ++. Просто используйте функции группировки doxygen (@addtogroup et al), чтобы упорядочить сгенерированную документацию, и все готово.

...