Doxygen für Verfahrensprogramme

Question

Ich habe einige große, hauptsächlich prozessurale Codes, die gut dokumentiert werden müssen.Dies beinhaltet im Allgemeinen in der Regel wiederholte Verwendung einer Anzahl von Funktionen, die in einer bestimmten Reihenfolge ausgeführt werden müssen.

doxygen ist ein tolles Produkt, erscheint aber sehr auf die Dokumentation von OOP-Codes.Hat jemand Tipps zur Verwendung von Doxygen auf natürliche Weise, um die Verfahrensarbeit zu dokumentieren?

Answer 1

Es gibt nichts von Natur aus, dass Doxygen funktioniert.Es kann einfach mehr Informationen zum OO-Code extrahieren, da er mehr Informationen darin hat (z. B. Vererbungsgrafiken).

Wir verwenden Doxygen für den einfachen C-Code, und es funktioniert ebenso gut, abzüglich der Informationen, die der einfache C im Vergleich zu C ++ nicht bereitstellt.Verwenden Sie einfach Doxygens Grupping (@addtogrup et al) -Funktionen, um die generierte Dokumentation zu organisieren, und Sie können gut tun.