Doxygen pour les programmes de procédure

Question

J'ai de grands codes de procédure qui doivent être bien documentés.Cela implique généralement une utilisation répétée d'un certain nombre de fonctions qui doivent être exécutées dans un certain ordre.

Doxygen est un excellent produit, mais il semble très orienté vers la documentation des codes de POO.Est-ce que quelqu'un a des conseils sur la manière d'utiliser Doxygen de manière naturelle de documenter les travaux de procédure?

Answer 1

Il n'y a rien de casse-t-il de manière inhérente à propos de la façon dont Doxygen fonctionne.Il est simplement capable d'extraire plus d'informations sur le code de l'OO car elle dispose de plus d'informations (par exemple, des graphes d'héritage).

Nous utilisons Doxygen pour le code CLAIR C et cela fonctionne aussi bien, moins les informations que la plaine C ne fournit pas par rapport à C ++.Il suffit d'utiliser des fonctionnalités de regroupement de Doxygen (@addtogroup et al) pour organiser la documentation générée et vous êtes prêt à faire.