Paul Kraus wrote:
> Reading through the doc's it says that it is preferred that you write
> the -h help info using POD. How is this down? Any links on how to write
> pod or have a perl script display pod for built in help.
>
> Do you guys really use POD to document your apps instead of #comments?
IMHO, comments should be few and far between. They break up the visual
flow of the code, which should reflect the execution logic. Far to better
to exercise care in selecting identifiers. Perl has allows identifiers to
be as long as needed to serve the purpose, and well-written code can simply
tell you in english what it is doing:
sub get_root_classes {
my $self = shift;
my @root_classes;
my @unresolved_classes;
foreach (keys $self->{'Classes'}) {
if ($_->{'parent'}) {
push $_, @unresolved_classes;
} else {
push $_, @root_classes;
}
}
return [EMAIL PROTECTED], [EMAIL PROTECTED];
}
Feedback? Is the above terribly mysterious about what it does? Does it
really requie comments to elucidate?
Joseph
--
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
