Was gehört alles in eine richtige Dokumentation?

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

Vorheriger Beitrag

Nächster Beitrag

r2c2

Registriert seit: 9. Mai 2005
Ort: Nordbaden
925 Beiträge

#20

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

9. Dez 2013, 20:27

Zitat von Graberius:

Sichwort Dokumentation
Egal ob du jetzt Object Pascal, C/C++, Java, Groovy, Velocity, HTML oder JavaScript Programmierst...
Kommentier wenigstens was eine Methode oder Funktion machen soll!!!

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.