Einzelnen Beitrag anzeigen

Benutzerbild von Codewalker
Codewalker

Registriert seit: 18. Nov 2005
Ort: Ratingen
945 Beiträge
 
Delphi XE2 Professional
 
#4

AW: Kommentare ausblenden

  Alt 15. Feb 2012, 08:28
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.
Klar, eine überlegte und stringente Namenskonvention spart viel Dokumentation. Aber gerade in größeren Projekten sind Hinweise zur Verwendung, Abhängigkeiten, Nebeneffekte, etc. auch über Benennungen nicht vollständig abzuhandeln. Es soll auch am Ende keine gedruckte Doku rauskommen (mit UML, etc.), sondern es soll der Delphi-Tooltip entsprechend aufbereitet werden, um schnell die nötigsten Infos zur Hand zu haben (s. Documentation Insight ToolTip Template)
  Mit Zitat antworten Zitat