Literate programming

aus Wikipedia, der freien Enzyklopädie

Du hast neue Nachrichten (Unterschied zur vorletzten Version).

Mit literate programming (engl. mit literarisches Programmieren übersetzbar) bezeichnet man das Schreiben von Computerprogrammen in einer Form, so dass sie vor allem für Menschen lesbar sind. Dies steht im Gegensatz zur konventionellen Ansicht, dass Programme hauptsächlich für den Computer lesbar sein sollen.

Literate programming bedeutet technisch gesehen, dass sowohl die Dokumentation als auch der Quelltext des Programms in einer gemeinsamen Datei vorhanden sind. Spezielle Werkzeuge sorgen dafür, dass sowohl der Quelltext als auch die Dokumentation aus dieser Datei extrahiert werden können. Da die für den Menschen geschriebene Dokumentation im Vordergrund steht, ist die Reihenfolge der Programmausdrücke so ausgelegt, dass diese verständlich dokumentiert werden können.

Inhaltsverzeichnis

1 Motivation
2 Geschichte
3 Verwandte Konzepte und Programme
- 3.1 Dokumentationsgeneratoren
- 3.2 Spezielle Programmiersprachen
4 Software
5 Literatur
6 Weblinks

[Bearbeiten] Motivation

In "Communications of the ACM" fragt 1986 Jon Bentley: "When was the last time you spent a pleasant evening in a comfortable chair, reading a good program". Der Hintergrund dieser Frage beruht auf der Tatsache, dass zwar so mancher Programmierer hervorragende Arbeit leistet und dementsprechend gute Programme erstellt, dass aber kaum ein Programmier seine Programme ausreichend dokumentiert. Die angesprochene Problematik wurde jedoch schon früher erkannt:

[Bearbeiten] Geschichte

Die erste Programmierumgebung, die literate programming unterstützte, war das von Donald Knuth entwickelte WEB. 1981 für die Implementierung des TeX-Systems entwickelt, benutzte es Pascal als Programmiersprache und TeX als Dokumentationsgenerator^[1]. Nachfolger von WEB war CWEB, welches C als Grundlage benutzte.

[Bearbeiten] Verwandte Konzepte und Programme

Das ursprüngliche Konzept wurde schließlich von anderen Entwicklern übernommen und fand in anderen Programmiersprachen ebenfalls teilweisen Niederschlag.

[Bearbeiten] Dokumentationsgeneratoren

Der Dokumentationsgenerator Doxygen (ähnlich wie Java mit Javadoc) setzt das Konzept teilweise um: Speziell formatierte Kommentare im Quelltext (in einer der unterstützten Programmiersprachen) können extrahiert und in eine Dokumentation einbezogen werden. Im Unterschied zum ursprünglichen Gedanken, wird durch dieses Konzept nur eine detailgetreue Spezifikation des Quelltextes und dessen Struktur ermöglicht (Funktionsparameter können genau spezifiziert werden). Eine vollständige Dokumentation des Quelltextes hingegen ist mit diesen Programmen nicht möglich, auch gerade weil eine Umordnung des Programms nicht möglich ist.

[Bearbeiten] Spezielle Programmiersprachen

Die Programmiersprache Haskell erlaubt literate programming bereits auf Quelltextebene: Kommentare und Programmanweisungen können beliebig gemischt werden. Im Gegensatz zu anderen Programmiersprachen wird bei dieser Strategie der Quelltext speziell markiert - und nicht die dazugehörigen Kommentare. Eine Umordnung ist jedoch auch hier nicht möglich.