Dokumentation Ihrer Perl-Programme

Wir hoffen, daß Sie Ihren Code dokumentieren, egal ob Sie ein Gelegenheitsentwickler sind oder nicht. Wenn Sie dokumentieren, sollten Sie die folgenden Abschnitte in Ihre POD-Dokumentation aufnehmen:

=head1 NAME

Der Name Ihres Programms oder Moduls.

=head1 ÜBERSICHT

Eine einzeilige Beschreibung Ihres Programms oder Moduls.

=head1 BESCHREIBUNG

Die eigentliche Dokumentation.

=head1 AUTOR

Wer Sie sind. (Oder ein Alias, wenn Sie sich Ihres Programms schämen.)

=head1 BUGS

Was Sie falsch gemacht haben (und warum es wirklich nicht Ihr Fehler ist).

=head1 SIEHE AUCH

Wo man weiterführende Informationen findet (um Ihre Bugs umgehen zu können).

=head1 COPYRIGHT

Der Copyright-Vermerk. Wenn Sie ein explizites Copyright angeben wollen, ...

Get Programmieren mit Perl now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.

Start your free trial