I forget the name of this commenting style, but its supposed to be a standard so that parsers can write the basic documentation for you.

#Requires:
#          var 1 to be valid <something>
#          var 2 to be valid <something>
#
#Returns:
#          var 1 is Preserver/Produces/Destroys
[download]

destroys means don't count on it being there, produces means that it is generated in that function and returned to the calling function and preserved means that it will return unchanged. mbond.

---

---

• 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.