Als Teil der Dokumentation meiner C ++ - Codebasis versuche ich, die vollständige Doxygen-Abdeckung zu erreichen - das heißt, ich möchte, dass alle meine (Hunderte von) Header-Dateien wohlgeformte Doxygen-Kommentare für ihre gesamte öffentliche API haben , damit ich Doxygen auf der Codebasis laufen lassen kann und keine Warnung "Warnung: Blah ist nicht dokumentiert" sieht.
Im Allgemeinen geht es nur darum, Sachen durchzugehen und zu dokumentieren, aber ich habe bemerkt, dass ich immer wieder den gleichen Text für jede Klasse eingib. Zum Beispiel habe ich im Wesentlichen viele Beispiele:
%Vor%Diese Kommentare sind (normalerweise) mehr oder weniger genau gleich für jede Klasse, weil diese Funktionen / Operatoren fast immer für jede Klasse genau gleich funktionieren. In der Tat wären Operatoren oder Kopierkonstruktoren, die sich auf andere Weise verhalten, ein fragwürdiges Entwurfsmuster, da C ++ - Programmierer normalerweise erwarten, dass Operatoren für jede Klasse auf dieselbe Weise arbeiten.
Meine Frage ist, gibt es einen Trick, mit dem ich Doxygen sagen kann, dass er eine angemessene Dokumentation für diese Dinge automatisch generiert (z. B. über irgendeine Art von Vorlage oder Makro), ohne dass ich diesen Text immer wieder manuell eingeben muss? Das würde die Menge an Text, die ich eingeben und pflegen muss, erheblich reduzieren, und es würde auch meine Header-Dateien entwirren, indem ich mir erlauben würde, Kommentare der "no duh" -Sorte zu entfernen, damit der Leser die Kommentare leichter finden kann Das bietet echte Einblicke.
Es gibt mehrere Befehle zum Kopieren der Dokumentation:
\copydoc
%Code%
\copybrief
Doxygen Hilfe schlägt die folgende Syntax vor:
%Vor%Damit können Sie die Dokumentation von einer Klasse in eine andere kopieren. Manchmal erstelle ich eine reine Dokumentation-Klasse, die nicht als Standard-Ort kompiliert wird, um im Rest des Projekts Dokumentation zu zeichnen.