Perl Guidelines for code, documentation and tests. WORK IN PROGRESS...
- Don't use bareword filehandles (checked by InputOutput::ProhibitBarewordFileHandles Perlcritic policy)
- Always use the three-argument form of
open(checked by InputOutput::ProhibitTwoArgOpen Perlcritic policy)
Example:
open($fh, '<', 'foo.txt');It's probably a good idea to use Path::Tiny module to handle file manipulations for bigger programs/scripts.
You should have at least these 4 POD sections in your module:
- NAME
- DESCRIPTION
- SYNOPSIS
- AUTHOR
Your module should look like this:
package My::Module;
=head1 NAME
My::Module - Module doing great stuff
=head1 DESCRIPTION
Module doing great stuff and a lot more !
=head1 SYNOPSIS
use My::Module;
my $mine = My::Module->new({user => $user, password => $password});
$mine->something($var);
=cut
...
1;
=head1 AUTHOR
Firstname Lastname <user@somedomain.com>
=cut