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]}

---

---

• Are you posting in the right place? Check out Where do I post X? to know for sure.
• Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:

  <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>

• Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
• Want more info? How to link or How to display code and escape characters are good places to start.