Programmierstil - #78983 (Allgemeines zu Perl)

sri

2007-07-29 21:06

User since
2004-01-29
828 Artikel
BenutzerIn

[quote=pktm,27.07.2007, 14:44]Was ich gerne mache wenn ich CGI::Application benutze ist POD als Kommentare benutzen, weil ich mir so direkt die Dokumentation aus meinen Modulen erzeugen lassen kann. So sieht eine typische Methode bei mit meistens so aus:

Code (perl): (dl )

=head2 methode( $schnitstellen, $parameter, $optional? )

Beschreibung der Funktion der Methode, was sie als Parameter nimmt, was sie damit macht, was sie zurück gibt usw. ToDo-Abschnitte stelle ich hier auch meistens rein.

=cut

sub methode {
    my $self = shift;
    # alle Parameter hier oben instantiieren, nicht irgendwo mitten im Code auf $_[x] zugreifen oder so.


    return 'immer! :-)';
} # /methode

[/quote]
Also ich wuerde nie wieder Inline-POD benutzen, es ist einfach unuebersichtlich und schwer zu pflegen.
Meiner Meinung nach sollte POD die API beschreiben und Kommentare die Interna.

Code: (dl )

package Foo;

#...

1;
__END__
=head1 lalala

=cut

So laesst sich die API Dokumentation schoen als Ganzes pflegen wodurch meist die Qualitaet erhoeht wird.\n\n

http://mojolicio.us/