Beefy Boxes and Bandwidth Generously Provided by pair Networks
Do you know where your variables are?
 
PerlMonks  

comment on

( [id://3333]=superdoc: print w/replies, xml ) Need Help??

Two points from Perl Best Practices (Documentation section) you might want to contemplate:

  • Distinguish user documentation from technical documentation.
  • Place POD as close as possible to the end of the file.

Personally, I dislike intermingling POD with code. Documentation of code is for programmers, so I use simple Perl comments (not POD) for that, right by the code it is documenting. Makes it easier to update the comments in step with the code.

Technical documentation of the system architecture (not the code) I place in a single large POD documentation section at the end of the file, or in a separate file.

User documentation should be kept separate from technical documentation. For that, I suggest either a separate POD file (or a big POD block at the end of the source file) ... or simply a Usage subroutine displayed when the user enters --help at the command line, making the user documentation more discoverable and more likely to be read.

See also:


In reply to Re: [RFC] Review of module code and POD (Doco) by eyepopslikeamosquito
in thread [RFC] Review of module code and POD by Bod

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":



  • 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.
Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others lurking in the Monastery: (3)
As of 2024-04-18 22:55 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found