Frage zu UML: Call by Reference Angabe in Operations section
-
Hallo
Ich möchte versuchen eine saubere Dokumentation meines cpp Progamms zu erstellen. Nachdem ich mich in Klassendiagramme und UML eingelesen habe und mit dem Editor DIA angefangen habe meine Klassen graphisch darzustellen, bin ich auf eine Frage gestoßen:
Im Operations Bereich in welchem die Membermethoden stehen gebe ich den Namen und Typ meiner Eingabeparameter ein. In der Literatur die ich fand wird an dieser Stelle nicht unterschieden ob call by value oder call by reference. Darf man nach UML Standard einfach den Referenz-Operator & mit angeben oder was ist da die Konvention?
Danke für Hilfe und Grüße
-
Dieser Thread wurde von Moderator/in SeppJ aus dem Forum C++ (alle ISO-Standards) in das Forum Rund um die Programmierung verschoben.
Im Zweifelsfall bitte auch folgende Hinweise beachten:
C/C++ Forum :: FAQ - Sonstiges :: Wohin mit meiner Frage?Dieses Posting wurde automatisch erzeugt.
-
Es gibt doch Software, die aus C++-Programmen UML-Diagramme (und Dokumentation) erzeugt. Normalerweise wird das als bessere Methode angesehen, denn:
- Die Doku steht dann auch im Code und nicht nur irgendwo extern. Das heißt, sie ist:
- Auch für andere Programme verfügbar, z.B. für die IDE.
- Auch für den Programmierer im Blick, selbst wenn er die Dokumentationsdatei nicht offen hat, sondern nur den Code sieht
- Für den Programmierer direkt verfügbar, so dass er Änderungen gleich dokumentieren kann, ohne ein externes Werkzeug zu bemühen
- Die Klassendiagramme stellen dann den Zustand dar, wie er wirklich ist, nicht wie er vielleicht mal theoretisch geplant war, bevor er dann viele Änderungen durchlief, die eventuell nicht dokumentiert wurden.
Ein Beispiel für ein solches Werkzeug ist doxygen.
-
Ich wusste nicht das ich in dieses Unterforum posten soll, da es ja um C++ Klassen geht. Rund um die Programmierung klingt auch gut. Entschuldige die Mühe SeppJ. Zukünftige UML Fragen schreibe ich hier rein
p.s.
Hab deinen Post jetzt gesehen. doxygen, ich guck danach.p.p.s.
Ist sogar in meinen Standard Repositories drinnen
-
Das funktioniert und wie geil. Fett
Vielen Dank für diesen Tipp.Hab die graphische Oberfläche gestartet, den doxygen wizzard ausgefüllt für die Einstellungen. Das ist echt benutzerfreundlich gemacht und als Output html mit Navigation und LaTeX angegeben und etwa zwei Sekunden nachdem ich run klickte war das auch fertig und sieht toll aus. Super
Was mich auch sehr freut: Ich hatte die Klassendiagramme von Hand fast richtig gemacht und zur Fragestellung hier: Der Referenz-Operator wird einfach mit angegeben, so wie ich das vermutet habe
Grüße
