Last active
December 28, 2015 22:19
-
-
Save AndrewRussellHayes/7570377 to your computer and use it in GitHub Desktop.
Genera Perl module template.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
#!/usr/bin/perl -w | |
package moduleName; | |
use strict; | |
use warnings; | |
#To view This Module's Documentation execute `perldoc modulename.pl` | |
=head2 module.pm | |
AUTHOR: Joe Developer | |
PACKAGE NAME: | |
CREATION DATE: | |
PURPOSE: Reason for Development of this utility | |
EXECUTION: Command and args go here | |
DEPENDENCIES: Other software necessary for proper module execution. | |
modulename => subroutine or reason | |
CHANGELOG: | |
DATE DEVELOPER DESCRIPTION | |
MM-DD-YYYY Joe Developer Change Description.. Blah Blah Blah. | |
ADDITIONAL DOCUMENTATION: | |
Additional information about inner workings of this module. | |
=cut | |
=head2 SUBROUTINES | |
=cut | |
=head3 moduleName::subname1($params) | |
Author: | |
ACCEPTS: these args | |
DOES: this function | |
RETURNS: this or that | |
DEPENDENCIES: Needs this module | |
NOTE: special considerations | |
=cut | |
sub subName{ | |
return; | |
} | |
=head3 moduleName::subname2() | |
Author: | |
ACCEPTS: these args | |
DOES: this function | |
RETURNS: this or that | |
NOTE: special considerations | |
=cut | |
sub subName{ | |
return; | |
} | |
1;#All modules must return true |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment