(CodeLib-Manager)
Registriert seit: 5. Aug 2004
Ort: München
1.062 Beiträge
|
AW: Wie und wieviel kommentiert Ihr Euren Code
4. Okt 2016, 15:05
Ich versuche mich prinzipiell daran zu orientieren:
Der Code erklärt selbst, was er macht. Kommentare ergänzen das Warum wenn erforderlich.
Im Bezug auf Dokumentation von Methoden und Klassen: Klassen haben bei mir seltenst Dokumentation; Methoden dokumentiere ich dann, wenn sie außerhalb der Klasse sichtbar sind. Dabei konzentriere ich mich auf Grenzfälle, Exceptions und nicht zwingend intuitive Verhaltensweisen.
Mike Passion is no replacement for reason
|