AGB  ·  Datenschutz  ·  Impressum  







Anmelden
Nützliche Links
Registrieren
Thema durchsuchen
Ansicht
Themen-Optionen

Was gehört alles in eine richtige Dokumentation?

Ein Thema von Back2Code · begonnen am 18. Nov 2013 · letzter Beitrag vom 14. Dez 2013
 
Graberius

Registriert seit: 22. Nov 2013
11 Beiträge
 
Delphi XE5 Architect
 
#34

AW: Was gehört alles in eine richtige Dokumentation?

  Alt 13. Dez 2013, 11:52
Zitat von r2c2:
Besser: Schreib deinen Code so, dass klar ist was er tut. Was eine Methode tun soll, sollte ihr Name verraten. Wenn ein Kommentar nötig ist, bedeutet das in 98,57% aller Fälle, dass entweder der Name falsch ist oder die Methode tut zu viel/das falsche und sollte aufgeteilt werden bzw. etwas anderes tun.
Da ich die Kommentar-Debatte ausgelöst habe werde ich sie hoffentlich auch beenden.
Mir ist auch klar das man einfache Methoden nicht Kommentieren muss/sollte um nicht einen Unleserlichen Kommentar zu gestallten.
Aber einfach mal so ne kleine Frage in den Raum...
Wie gut könnt ihr sehr schnell etwas ändern wenn eine Methode geschrieben wurde ohne das irgendwer es für nötig gefunden hat
zu erklären woher z.B. eine GUID (in Intrexx Standard und in Delphi auch verfügbar)stammt?
Kann sein das man die GUID schnell findet aber ich wünsche viel Vergnügen beim Suchen wenn die GUID zerschossen wurde...
Dann hat man das unschöne Vergnügen folgende Dinge zu tun:
  • Denn ersteller Suchen
  • Denn gesammten SourceCode durchsuchen
  • Die gesammte Applikation durchgehen
Bei kleinen Sachen ist das ja nicht unbedingt ein grosser Aufwand aber wenn man eine Komplexe
Applikation vor sich hat würde man sich Wünschen man könnte nur dem Beschrieb vom Kommentar folgen

Das Mass halten gehört wohl zu denn Schwierigsten Herausforderungen des Lebens...
Von daher ist niemand Perfekt aber ein Code komplett ohne Kommentar zu erstellen ist ein (schwer)Verbrechen

Geändert von Graberius (13. Dez 2013 um 11:56 Uhr)
  Mit Zitat antworten Zitat
 


Forumregeln

Es ist dir nicht erlaubt, neue Themen zu verfassen.
Es ist dir nicht erlaubt, auf Beiträge zu antworten.
Es ist dir nicht erlaubt, Anhänge hochzuladen.
Es ist dir nicht erlaubt, deine Beiträge zu bearbeiten.

BB-Code ist an.
Smileys sind an.
[IMG] Code ist an.
HTML-Code ist aus.
Trackbacks are an
Pingbacks are an
Refbacks are aus

Gehe zu:

Impressum · AGB · Datenschutz · Nach oben
Alle Zeitangaben in WEZ +1. Es ist jetzt 18:28 Uhr.
Powered by vBulletin® Copyright ©2000 - 2025, Jelsoft Enterprises Ltd.
LinkBacks Enabled by vBSEO © 2011, Crawlability, Inc.
Delphi-PRAXiS (c) 2002 - 2023 by Daniel R. Wolf, 2024-2025 by Thomas Breitkreuz