Einzelnen Beitrag anzeigen

Benutzerbild von Luckie
Luckie

Registriert seit: 29. Mai 2002
37.621 Beiträge
 
Delphi 2006 Professional
 
#2

AW: Kommentare ausblenden

  Alt 15. Feb 2012, 08:21
Genau das ist der Grund warum ich solche Dokumentationsgeneratoren nicht mag. Aber wozu die Kommentare überhaupt? Benenne deine Enums gescheit und du musst nicht zu jedem einen Kommentar schreiben. Benenne Routinen gescheit und es erübrigt sich ein Kommentar. Benenne die Parameter gescheit und es erübrigt sich ein Kommentar. Den Dokumentengeneartor braucht man dann nur noch um eine Dokumentation zu erstellen, die eine Übersicht des Codes erzeugt, um sich einen Überblick zu verschaffen, wie die Codeteile zusammenarbeiten und wie die Klassenstruktur und -hierarchie aufgebaut ist. UML-Diagramm dazu und man hat alles, was man braucht. Vielleicht noch ein paar selbst getippte einleitende Worte, was die Idee hinter dem ganzen ist und was man sich dabei gedacht hat.
Michael
Ein Teil meines Codes würde euch verunsichern.
  Mit Zitat antworten Zitat