Eingebettete Dokumentation

hello-world.pl

#!/usr/local/bin/perl -w =head1 NAME hello-world -- print greeting =head1 SYNOPSIS hello-world =head1 DESCRIPTION hello-world just prints ``Hello world!'' and exits. =cut print "Hello world!\n";

Innerhalb eines Perl-Programmtextes kann an beliebiger Stelle Text für die zugehörige Dokumentation im Pod-Format (plain old documentation) eingefügt werden.

Textabschnitte für die Dokumentation beginnen mit einer =-Direktive am Anfang einer Zeile und enden mit =cut (ebenfalls am Anfang einer Zeile).

Eine verwandte Technik ist die des literate programming, die insbesondere durch Donald Knuth bei \TeX{} populär wurde. Jedoch steht bei literate programming mehr die Erläuterung des Programmtexts in Vordergrund als die Benutzung.

	Innerhalb eines Perl-Programmtextes kann an beliebiger Stelle Text für die zugehörige Dokumentation im Pod-Format (plain old documentation) eingefügt werden.
	Textabschnitte für die Dokumentation beginnen mit einer `=`-Direktive am Anfang einer Zeile und enden mit `=cut` (ebenfalls am Anfang einer Zeile).
	Eine verwandte Technik ist die des literate programming, die insbesondere durch Donald Knuth bei \TeX{} populär wurde. Jedoch steht bei literate programming mehr die Erläuterung des Programmtexts in Vordergrund als die Benutzung.