jlongino has asked for the wisdom of the Perl Monks concerning the following question:
I'm currently working on a module and have most of the
coding finished. One area I'm not sure about is whether or
not I should put required "use" statements in the module
or should the documentation specify that the end user add
the appropriate ones in their program?
The next step is embedding module documentation but, having never done this (embedding it in the module) before, I could use some advice.
I searched a bit on this site, but received too many hits and was unable to narrow the keywords down. I noticed c's post Call for (gentle) critique. and think that it would serve as an excellent example to use as a template. Is there anything in addition to this example that I should add?
If anyone can point me to other good documentation on the subject, I would appreciate it greatly.
@a=split??,'just lose the ego and get involved!'; for(split??,'afqtw{|~'){print $a[ord($_)-97]}
|
---|
Replies are listed 'Best First'. | |
---|---|
Re: Documenting a Module
by dragonchild (Archbishop) on Sep 01, 2001 at 00:40 UTC | |
Re: Documenting a Module
by tachyon (Chancellor) on Sep 01, 2001 at 00:57 UTC | |
Re: Documenting a Module
by Masem (Monsignor) on Sep 01, 2001 at 00:38 UTC |
Back to
Seekers of Perl Wisdom