Comment-driven development

Comment-driven development (CDD, deutsch kommentargetriebene Softwareentwicklung) ist die Bezeichnung für eine Programmiertechnik, bei der zuerst der Sinn eines oder mehrere Programmabschnitte mit Hilfe von Kommentaren im Quelltext beschrieben wird. Erst wenn auf diese Weise die Sinn bzw. fachliche Logik des Programms bzw. Programmteils beschrieben ist, wird dies dann in der jeweiligen Programmiersprache codiert.

Comment-driven development dient dazu dem Programmierer und Anderen, welche den Code später weiter bearbeiten, Klarheit über die Aufgabe des Programmcodes bzw. das von diesem gelöste Problem zu verschaffen. Es erleichtert so die Wartbarkeit und das spätere Verständnis des Codes, insbesondere von Altsystemen (sogenanntem Legacy Code).[1] Die so entstanden Kommentare können gleichzeitig als Grundlage für die Dokumentation der Software dienen. Dies gilt insbesondere für die Dokumentation der API bei einer ausführlicheren Beschreibung des Verhaltens der nicht privaten Programmobjekte während deren Entwicklung.[2]

Die Kombination mit anderen Programmiertechniken wie testgetriebene Entwicklung (TDD) oder Behavior Driven Development (BDD) verbessert noch die Klarheit und Wartbarkeit des Programmcodes. So erleichtern Kommentare mit der Beschreibung noch nicht implementierter Programmobjekte die Erstellung der Unit-Tests im Rahmen des TDD und das Verständnis des vom Programm erwarteten Verhaltens.[1]

Literatur

  • John Ousterhout (Übersetzer Thomas Demmig): Prinzipien des Softwaredesigns. 2021, ISBN 978-3-96009-159-2, Kapitel 15: Erst die Kommentare schreiben (nutzen Sie Kommentare als Teil des Designprozesses), S. 143–146.

Einzelnachweise

  1. ↑ a b James Edwards, Comment-Driven Development
  2. ↑ Ralf Holly, Comment-Driven Development

Content Disclaimer

Informasi ini disarikan dari Wikipedia dan disajikan kembali untuk tujuan edukasi. Konten tersedia di bawah lisensi CC BY-SA 3.0. Kami tidak bertanggung jawab atas ketidakakuratan data yang bersumber dari kontribusi publik tersebut.

  1. The information displayed on this website is sourced in part or in whole from Wikipedia and has been adapted for the purpose of restating it. We strive to provide accurate and relevant information, however:
  2. There is no guarantee of absolute accuracy. Wikipedia is an open, collaborative project that can be edited by anyone, so information is subject to change.
  3. It is not intended to constitute professional advice. The content displayed is for informational and educational purposes only. For important decisions (e.g., medical, legal, or financial), please consult a professional.
  4. Content copyright. Wikipedia is licensed under the Creative Commons Attribution-ShareAlike License (CC BY-SA). This means that content may be reused with appropriate attribution and shared under a similar license.
  5. Responsible use. Any risk arising from the use of information from this website is entirely the responsibility of the user.