KAPITEL 15
Erst die Kommentare schreiben (nutzen Sie Kommentare als Teil des Designprozesses)
Viele verschieben das Schreiben der Dokumentation an das Ende des Entwicklungsprozesses – nachdem Programmieren und Unit Testing abgeschlossen sind. Das ist einer der sichersten Wege, um bei der Dokumentation für eine schlechte Qualität zu sorgen. Am besten schreiben Sie Kommentare zu Beginn des Prozesses, während Sie auch den Code schreiben. Damit wird die Dokumentation Teil des Designprozesses. Sie schaffen auf diese Weise nicht nur eine bessere Dokumentation, sondern auch bessere Designs, und das Schreiben der Doku macht so auch mehr Spaß.
Aufgeschobene Kommentare sind schlechte Kommentare
So gut wie alle Entwicklerinnen und Enwickler, die ich jemals ...
Get Prinzipien des Softwaredesigns now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
