Wikipedia · einfach zusammengefasst · Stand
Comment-driven development
Comment-driven development dient dazu dem Programmierer und Anderen, welche den Code später weiter bearbeiten, Klarheit über die Aufgabe des Programmcodes bzw.
Inhalt3 Abschnitte
Kernidee
Comment-driven development (CDD), auf Deutsch kommentargetriebene Softwareentwicklung, ist eine Programmiertechnik. Dabei wird zuerst im Quelltext durch Kommentare beschrieben, welchen Sinn ein oder mehrere Programmabschnitte haben und welche fachliche Logik sie umsetzen sollen. Erst danach wird diese Beschreibung in der jeweiligen Programmiersprache als Code umgesetzt.
Zweck und Nutzen
CDD soll Programmiererinnen und Programmierern sowie späteren Bearbeitenden des Codes klar machen, welche Aufgabe ein Programmteil erfüllt und welches Problem er löst. Dadurch wird der Code leichter verständlich und besser wartbar.
Besonders hilfreich ist dies bei Altsystemen, also sogenanntem Legacy Code. Die beim Entwickeln entstehenden Kommentare können außerdem als Grundlage für die Dokumentation der Software dienen, vor allem für die API-Dokumentation. Das gilt besonders, wenn das Verhalten nicht privater Programmobjekte während der Entwicklung ausführlicher beschrieben wird.
Zusammenhang mit anderen Methoden
CDD kann mit anderen Programmiertechniken kombiniert werden, zum Beispiel mit testgetriebener Entwicklung (TDD) oder Behavior Driven Development (BDD). Diese Kombination kann die Klarheit und Wartbarkeit des Programmcodes weiter verbessern.
Kommentare, die noch nicht implementierte Programmobjekte beschreiben, helfen bei TDD auch dabei, Unit-Tests zu erstellen. Außerdem erleichtern sie das Verständnis dafür, welches Verhalten vom Programm erwartet wird.