in reply to Re: How to use getopt and $#argv together?
in thread How to use getopt and $#argv together?
Can someone explain what the below statements mean?I looked at the usage doc,quite confusing
pod2usage ( -verbose => $help ) if $help; pod2usage ( -verbose => 1 ) unless scalar @services; pod2usage ( -verbose => 1 ) unless $operation and $message and $owner;
|
|---|
| Replies are listed 'Best First'. | |
|---|---|
|
Re^3: How to use getopt and $#argv together?
by TomDLux (Vicar) on Mar 09, 2011 at 21:09 UTC | |
Besides the lines above, i also invoke pod2usage if Getops returns an failure errorcode:
Every file should contain within it the documentation for that script, in POD format. Type perldoc perlpod into an xterm, or browse http://perldoc.perl.org/perlpod.html for details. On the one hand, it's unsophisticated. On the other hand, it asks a lot. But people wouldn't fill in more complicated formatting, and you need to provide certain information. My solution is to set up a template file, which has everything I need to start a new script. it contains a few things I frequently use but may not need. My boss likes to have the RCS keywords. The ## no critic is to make perlcritic not complain about that line.
As Occam said: Entia non sunt multiplicanda praeter necessitatem. | [reply] [d/l] [select] |
|
Re^3: How to use getopt and $#argv together?
by mpeever (Friar) on Mar 09, 2011 at 23:21 UTC | |
The Pod::Usage module provides pod2usage, which parses the POD documentation in your program and generates a usage message from it. I have those lines in place to handle two different use cases. First, if you call this program (no, it's not a complete program, just a snippet of some production code) with a -h or --help, it will print a usage message and exit. This is standard across the code I've written at this job. Second, there are required fields that are being checked. If there is no value for any of those fields (@services, $operation, etc.) then we present a usage message and exit. pod2usage causes the program to exit, so it's an effective check of whether continuing is actually feasible. This implies that I keep up the POD on my programs. I consider POD necessary in production code, so that's a non-issue. Not that I've never violated that rule... If you call pod2usage with a higher -verbose value, it prints out more information. This allows me to provide more or less detail based on how many -h flags were handed into my program. A single one means a simple usage message, multiples produce something like a manpage. | [reply] [d/l] [select] |