In meinem Team haben wir einen Design-by-Contract-Ansatz für unseren C ++-Code, den wir in unseren Doxygen-Kommentaren ausdrücken. Deklaration, die erklärt, welche Parameter, seine Voraussetzungen, seine Rückgaberichte und Nachschläge sind, damit die Anrufer genau wissen, wie sich die Funktion verhalten sollte, ohne die Funktion implementieren zu müssen. < /p>
WE Ich möchte auch, dass dieser Doxygen -Kommentar an der Spitze jeder Funktionsdefinition steht, da die Funktionen der Funktion wissen oder aufrechterhalten werden, was die Implementierung tun soll, damit sie sicherstellen können, dass sie das richtige tut.
Da der gleiche Doxygen -Kommentar jedoch an zwei Stellen sein muss, wirft die Frage auf, wie beide im Laufe der Zeit gleich bleiben. Gibt es ein Tool oder eine Doxygen -Option, mit der Sie überprüfen können, ob beide Kommentare gleich sind?
Gibt es eine Möglichkeit, den Doxygen -Kommentar für die Erklärung und die Definition zu überprüfen? ⇐ C++
-
- Similar Topics
- Replies
- Views
- Last post
-
-
Eine Erklärung für das Verhalten eines grundlegenden Baumrezisivgenerators
by Anonymous » » in Python - 0 Replies
- 3 Views
-
Last post by Anonymous
-