Literate Programming - Versionsgeschichte

Mosmas: /* Eigenschaften eines Literate-Programming-Systems */Satzbau

2023-12-13T16:08:31Z

Eigenschaften eines Literate-Programming-Systems: Satzbau

← Nächstältere Version		Version vom 13. Dezember 2023, 18:08 Uhr
Zeile 13:		Zeile 13:

	# Quellcode und Kommentare können miteinander gemischt werden.		# Quellcode und Kommentare können miteinander gemischt werden.
	# Die Quellcode-Abschnitte können in beliebiger Reihenfolge angeordnet werden. Das Literate-Programming-System setzt sie automatisch in der Reihenfolge zusammen, so dass sie ausgeführt werden können (''tangle'').		# Die Quellcode-Abschnitte können in beliebiger Reihenfolge angeordnet werden. Das Literate-Programming-System setzt sie automatisch in der richtigen Reihenfolge zusammen, so dass sie ausgeführt werden können (''tangle'').
	# Aus Programm und Beschreibung kann automatisch eine lesbare Dokumentation mit Inhaltsverzeichnis, Verweisen, Registern etc. erstellt werden (''weave'').		# Aus Programm und Beschreibung kann automatisch eine lesbare Dokumentation mit Inhaltsverzeichnis, Verweisen, Registern etc. erstellt werden (''weave'').

Paintdog: Paintdog verschob die Seite Beschriebenes Programmieren nach Literate Programming: Für den anderen Begriff liefert Google nur den WP-Artikel; Eindeutschung in der Informatik nicht üblich; Begriffsbildung ist nicht gewünscht

2023-12-12T18:00:29Z

Paintdog verschob die Seite Beschriebenes Programmieren nach Literate Programming: Für den anderen Begriff liefert Google nur den WP-Artikel; Eindeutschung in der Informatik nicht üblich; Begriffsbildung ist nicht gewünscht

← Nächstältere Version	Version vom 12. Dezember 2023, 20:00 Uhr
(kein Unterschied)

Paintdog: Änderungen von Jakob5 (Diskussion) auf die letzte Version von ElLutzo zurückgesetzt

2023-12-12T17:59:18Z

Änderungen von Jakob5 (Diskussion) auf die letzte Version von ElLutzo zurückgesetzt

Jakob5: /* Geschichte */

2023-12-12T13:27:56Z

Geschichte

← Nächstältere Version		Version vom 12. Dezember 2023, 15:27 Uhr
Zeile 7:		Zeile 7:

	== Geschichte ==		== Geschichte ==
	Die angesprochene Problematik wurde jedoch schon früher erkannt: Die erste Programmierumgebung, die ~~veschriebenes~~ Programmieren unterstützte, war das von [[Donald Knuth]] entwickelte [[WEB (Programmiersprache)\|WEB]]. 1981 für die Implementierung des [[TeX]]-Systems entwickelt, benutzte es [[Pascal (Programmiersprache)\|Pascal]] als Programmiersprache und TeX als Dokumentationsgenerator.<ref>Der Quellcode von TeX wurde in ''TeX: The program'' von Donald Knuth veröffentlicht</ref> Nachfolger von WEB war [[CWEB]], welches [[C (Programmiersprache)\|C]] als Grundlage benutzte.		Die angesprochene Problematik wurde jedoch schon früher erkannt: Die erste Programmierumgebung, die beschriebenes Programmieren unterstützte, war das von [[Donald Knuth]] entwickelte [[WEB (Programmiersprache)\|WEB]]. 1981 für die Implementierung des [[TeX]]-Systems entwickelt, benutzte es [[Pascal (Programmiersprache)\|Pascal]] als Programmiersprache und TeX als Dokumentationsgenerator.<ref>Der Quellcode von TeX wurde in ''TeX: The program'' von Donald Knuth veröffentlicht</ref> Nachfolger von WEB war [[CWEB]], welches [[C (Programmiersprache)\|C]] als Grundlage benutzte.

	== Eigenschaften eines Literate-Programming-Systems ==		== Eigenschaften eines Literate-Programming-Systems ==

Jakob5: Übersetzung

2023-12-12T13:19:27Z

Übersetzung

Jakob5: Jakob5 verschob die Seite Literate programming nach Beschriebenes Programmieren: korrekte Bezeichnung: literate Programming kann man gut und treffend durch "Beschriebenes Programmieren" übersetzen. Nicht: Beschreibendes, da dann das Programmieren selbst beschreibend wäre. Beschrieben bedeutet, das Programmieren selbst ist "beschrieben"

2023-12-12T13:15:57Z

Jakob5 verschob die Seite Literate programming nach Beschriebenes Programmieren: korrekte Bezeichnung: literate Programming kann man gut und treffend durch "Beschriebenes Programmieren" übersetzen. Nicht: Beschreibendes, da dann das Programmieren selbst beschreibend wäre. Beschrieben bedeutet, das Programmieren selbst ist "beschrieben"

← Nächstältere Version	Version vom 12. Dezember 2023, 15:15 Uhr
(kein Unterschied)

ElLutzo: /* Programming by Intention */ Link-Fix: http://www.netobjectives.net/files/books/esad/essential-skills-programming-by-intention.pdf

2019-12-07T20:53:38Z

Programming by Intention: Link-Fix: http://www.netobjectives.net/files/books/esad/essential-skills-programming-by-intention.pdf

← Nächstältere Version		Version vom 7. Dezember 2019, 22:53 Uhr
Zeile 29:		Zeile 29:

	=== Programming by Intention ===		=== Programming by Intention ===
	Programming by Intention (nicht zu verwechseln mit [[Intentionale Programmierung\|Intentionaler Programmierung]]) ist ein Konzept der [[Agile Softwareentwicklung\|Agilen Softwareentwicklung]], welches besagt, dass bei der Implementierung von Methoden nicht wie üblich Algorithmen implementiert werden, sondern „nur“ Intentionen niedergeschrieben werden. Diese Intentionen entsprechen dann üblicherweise weiteren Hilfsmethoden oder einzeiligen Algorithmen. Damit wird sichergestellt, dass das Programm auch ohne Programmierkenntnisse äußerst einfach zu lesen ist.<ref>[http://www.netobjectives.~~com~~/files/essential-skills-programming-by-intention.pdf Programming by Intention, Essential Skills for the Agile Developer] (PDF; 731 kB)</ref>		Programming by Intention (nicht zu verwechseln mit [[Intentionale Programmierung\|Intentionaler Programmierung]]) ist ein Konzept der [[Agile Softwareentwicklung\|Agilen Softwareentwicklung]], welches besagt, dass bei der Implementierung von Methoden nicht wie üblich Algorithmen implementiert werden, sondern „nur“ Intentionen niedergeschrieben werden. Diese Intentionen entsprechen dann üblicherweise weiteren Hilfsmethoden oder einzeiligen Algorithmen. Damit wird sichergestellt, dass das Programm auch ohne Programmierkenntnisse äußerst einfach zu lesen ist.<ref>[http://www.netobjectives.net/files/books/esad/essential-skills-programming-by-intention.pdf Programming by Intention, Essential Skills for the Agile Developer] (PDF; 731 kB)</ref>

	== Software ==		== Software ==

Mosmas: /* Spezielle Programmiersprachen */Großschreibung

2018-12-14T16:18:27Z

Spezielle Programmiersprachen: Großschreibung

← Nächstältere Version		Version vom 14. Dezember 2018, 18:18 Uhr
Zeile 23:		Zeile 23:

	=== Spezielle Programmiersprachen ===		=== Spezielle Programmiersprachen ===
	Die Programmiersprache [[Haskell (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.		Die Programmiersprache [[Haskell (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.

	=== Generelle Textsatzsysteme ===		=== Generelle Textsatzsysteme ===

Mosmas: /* Eigenschaften eines Literate-Programming-Systems */Großschreibung

2018-12-14T16:16:41Z

Eigenschaften eines Literate-Programming-Systems: Großschreibung

← Nächstältere Version		Version vom 14. Dezember 2018, 18:16 Uhr
Zeile 10:		Zeile 10:

	== Eigenschaften eines Literate-Programming-Systems ==		== Eigenschaften eines Literate-Programming-Systems ==
	Ein Literate-Programming-System ermöglicht ~~folgendes~~:		Ein Literate-Programming-System ermöglicht Folgendes:

	# Quellcode und Kommentare können miteinander gemischt werden.		# Quellcode und Kommentare können miteinander gemischt werden.

78.54.73.72: Typo

2016-10-20T22:10:42Z

Typo

← Nächstältere Version		Version vom 21. Oktober 2016, 00:10 Uhr
Zeile 4:		Zeile 4:

	== Motivation ==		== Motivation ==
	In ''Communications of the ACM'' fragt 1986 Jon Bentley: {{lang\|en\|When was the last time you spent a pleasant evening in a comfortable chair, reading a good program?}} (deutsch: „Wann war das letzte Mal, dass ~~sie~~ einen angenehmen Abend in einem bequemen Sessel verbracht haben und dabei ein gutes Programm gelesen haben?“) 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 Programmierer seine Programme ausreichend dokumentiert.		In ''Communications of the ACM'' fragt 1986 Jon Bentley: {{lang\|en\|When was the last time you spent a pleasant evening in a comfortable chair, reading a good program?}} (deutsch: „Wann war das letzte Mal, dass Sie einen angenehmen Abend in einem bequemen Sessel verbracht haben und dabei ein gutes Programm gelesen haben?“) 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 Programmierer seine Programme ausreichend dokumentiert.

	== Geschichte ==		== Geschichte ==

← Nächstältere Version		Version vom 12. Dezember 2023, 19:59 Uhr
Zeile 1:		Zeile 1:
	Mit ~~Beschriebenes Programmieren (engl.~~ {{lang\|en\|'''literate programming'''}}, näherungsweise mit ''literarisches Programmieren'' übersetzbar) bezeichnet man das Schreiben von [[Computerprogramm]]en in einer Form, so dass sie vor allem für Menschen lesbar sind.		Mit {{lang\|en\|'''literate programming'''}} (engl., näherungsweise mit ''literarisches Programmieren'' übersetzbar) bezeichnet man das Schreiben von [[Computerprogramm]]en in einer Form, so dass sie vor allem für Menschen lesbar sind.

	~~Beschriebenes~~ ~~Programmieren~~ 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.		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.

	== Motivation ==		== Motivation ==
Zeile 7:		Zeile 7:

	== Geschichte ==		== Geschichte ==
	Die angesprochene Problematik wurde jedoch schon früher erkannt: Die erste Programmierumgebung, die ~~beschriebenes~~ ~~Programmieren~~ unterstützte, war das von [[Donald Knuth]] entwickelte [[WEB (Programmiersprache)\|WEB]]. 1981 für die Implementierung des [[TeX]]-Systems entwickelt, benutzte es [[Pascal (Programmiersprache)\|Pascal]] als Programmiersprache und TeX als Dokumentationsgenerator.<ref>Der Quellcode von TeX wurde in ''TeX: The program'' von Donald Knuth veröffentlicht</ref> Nachfolger von WEB war [[CWEB]], welches [[C (Programmiersprache)\|C]] als Grundlage benutzte.		Die angesprochene Problematik wurde jedoch schon früher erkannt: Die erste Programmierumgebung, die literate programming unterstützte, war das von [[Donald Knuth]] entwickelte [[WEB (Programmiersprache)\|WEB]]. 1981 für die Implementierung des [[TeX]]-Systems entwickelt, benutzte es [[Pascal (Programmiersprache)\|Pascal]] als Programmiersprache und TeX als Dokumentationsgenerator.<ref>Der Quellcode von TeX wurde in ''TeX: The program'' von Donald Knuth veröffentlicht</ref> Nachfolger von WEB war [[CWEB]], welches [[C (Programmiersprache)\|C]] als Grundlage benutzte.

	== Eigenschaften eines Literate-Programming-Systems ==		== Eigenschaften eines Literate-Programming-Systems ==
Zeile 23:		Zeile 23:

	=== Spezielle Programmiersprachen ===		=== Spezielle Programmiersprachen ===
	Die Programmiersprache [[Haskell (Programmiersprache)\|Haskell]] erlaubt ~~beschriebenes~~ ~~Programmieren~~ 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.		Die Programmiersprache [[Haskell (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.

	=== Generelle Textsatzsysteme ===		=== Generelle Textsatzsysteme ===
	Durch geeignetes Verschränken von Quellcode und Kommentar kann man bei Einsatz geeigneter [[Textsatzsystem]]e ~~Beschriebenes~~ ~~Programmieren~~ erreichen. So kann man zum Beispiel C-Quellcode so schreiben, dass er mit dem C-Compiler zu einem Programm kompiliert werden kann, aber mit [[troff]]/[[groff]] daraus auch ein Postscript-Dokument mit Grafiken erzeugt werden kann. Dabei sind gegenüber „echten“ Literate-Programming-Tools einige Einschränkungen in der Funktionalität in Kauf zu nehmen, da eine spezielle Software mehr Möglichkeiten anbieten kann als generelle Textsatzsysteme.<ref>[http://www.first.in-berlin.de/software/tools/multiple/ Beispiel für Einsatz von troff/groff für ~~Beschriebenes~~ ~~Programmieren~~]</ref>		Durch geeignetes Verschränken von Quellcode und Kommentar kann man bei Einsatz geeigneter [[Textsatzsystem]]e Literate Programming erreichen. So kann man zum Beispiel C-Quellcode so schreiben, dass er mit dem C-Compiler zu einem Programm kompiliert werden kann, aber mit [[troff]]/[[groff]] daraus auch ein Postscript-Dokument mit Grafiken erzeugt werden kann. Dabei sind gegenüber „echten“ Literate-Programming-Tools einige Einschränkungen in der Funktionalität in Kauf zu nehmen, da eine spezielle Software mehr Möglichkeiten anbieten kann als generelle Textsatzsysteme.<ref>[http://www.first.in-berlin.de/software/tools/multiple/ Beispiel für Einsatz von troff/groff für Literate Programming]</ref>

	=== Programming by Intention ===		=== Programming by Intention ===

← Nächstältere Version		Version vom 12. Dezember 2023, 15:19 Uhr
Zeile 1:		Zeile 1:
	Mit {{lang\|en\|'''literate programming'''}} ~~(engl.~~, näherungsweise mit ''literarisches Programmieren'' übersetzbar) bezeichnet man das Schreiben von [[Computerprogramm]]en in einer Form, so dass sie vor allem für Menschen lesbar sind.		Mit Beschriebenes Programmieren (engl. {{lang\|en\|'''literate programming'''}}, näherungsweise mit ''literarisches Programmieren'' übersetzbar) bezeichnet man das Schreiben von [[Computerprogramm]]en in einer Form, so dass sie vor allem für Menschen lesbar sind.

	~~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.		Beschriebenes Programmieren 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.

	== Motivation ==		== Motivation ==
Zeile 7:		Zeile 7:

	== Geschichte ==		== Geschichte ==
	Die angesprochene Problematik wurde jedoch schon früher erkannt: Die erste Programmierumgebung, die ~~literate~~ ~~programming~~ unterstützte, war das von [[Donald Knuth]] entwickelte [[WEB (Programmiersprache)\|WEB]]. 1981 für die Implementierung des [[TeX]]-Systems entwickelt, benutzte es [[Pascal (Programmiersprache)\|Pascal]] als Programmiersprache und TeX als Dokumentationsgenerator.<ref>Der Quellcode von TeX wurde in ''TeX: The program'' von Donald Knuth veröffentlicht</ref> Nachfolger von WEB war [[CWEB]], welches [[C (Programmiersprache)\|C]] als Grundlage benutzte.		Die angesprochene Problematik wurde jedoch schon früher erkannt: Die erste Programmierumgebung, die veschriebenes Programmieren unterstützte, war das von [[Donald Knuth]] entwickelte [[WEB (Programmiersprache)\|WEB]]. 1981 für die Implementierung des [[TeX]]-Systems entwickelt, benutzte es [[Pascal (Programmiersprache)\|Pascal]] als Programmiersprache und TeX als Dokumentationsgenerator.<ref>Der Quellcode von TeX wurde in ''TeX: The program'' von Donald Knuth veröffentlicht</ref> Nachfolger von WEB war [[CWEB]], welches [[C (Programmiersprache)\|C]] als Grundlage benutzte.

	== Eigenschaften eines Literate-Programming-Systems ==		== Eigenschaften eines Literate-Programming-Systems ==
Zeile 23:		Zeile 23:

	=== Spezielle Programmiersprachen ===		=== Spezielle Programmiersprachen ===
	Die Programmiersprache [[Haskell (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.		Die Programmiersprache [[Haskell (Programmiersprache)\|Haskell]] erlaubt beschriebenes Programmieren 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.

	=== Generelle Textsatzsysteme ===		=== Generelle Textsatzsysteme ===
	Durch geeignetes Verschränken von Quellcode und Kommentar kann man bei Einsatz geeigneter [[Textsatzsystem]]e ~~Literate~~ ~~Programming~~ erreichen. So kann man zum Beispiel C-Quellcode so schreiben, dass er mit dem C-Compiler zu einem Programm kompiliert werden kann, aber mit [[troff]]/[[groff]] daraus auch ein Postscript-Dokument mit Grafiken erzeugt werden kann. Dabei sind gegenüber „echten“ Literate-Programming-Tools einige Einschränkungen in der Funktionalität in Kauf zu nehmen, da eine spezielle Software mehr Möglichkeiten anbieten kann als generelle Textsatzsysteme.<ref>[http://www.first.in-berlin.de/software/tools/multiple/ Beispiel für Einsatz von troff/groff für ~~Literate~~ ~~Programming~~]</ref>		Durch geeignetes Verschränken von Quellcode und Kommentar kann man bei Einsatz geeigneter [[Textsatzsystem]]e Beschriebenes Programmieren erreichen. So kann man zum Beispiel C-Quellcode so schreiben, dass er mit dem C-Compiler zu einem Programm kompiliert werden kann, aber mit [[troff]]/[[groff]] daraus auch ein Postscript-Dokument mit Grafiken erzeugt werden kann. Dabei sind gegenüber „echten“ Literate-Programming-Tools einige Einschränkungen in der Funktionalität in Kauf zu nehmen, da eine spezielle Software mehr Möglichkeiten anbieten kann als generelle Textsatzsysteme.<ref>[http://www.first.in-berlin.de/software/tools/multiple/ Beispiel für Einsatz von troff/groff für Beschriebenes Programmieren]</ref>

	=== Programming by Intention ===		=== Programming by Intention ===