Beefy Boxes and Bandwidth Generously Provided by pair Networks
Perl: the Markov chain saw
 
PerlMonks  

comment on

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

Hello KABA. Welcome to the Monastery!

The "Comments and Documentation" section at On Coding Standards and Code Reviews seems relevant to your comment, in particular:

  • Separate user versus maintainer documentation.
  • Include a comment block on every non-trivial method describing its purpose.

These are general guidelines, applicable to any language, not just Perl. Some prefer to comment Perl functions with POD. I find intermingling code with POD doesn't suit my brain, I prefer to put all the POD at the end of the file, and reserve it for public functions only (i.e. the external interface to the component) - I don't use POD to document internal functions.

When I describe a function parameter, I like to state explicitly whether it is an input parameter, an output parameter, or an "inout" parameter ("inout" parameters should be used sparingly).

Put another way, the POD at the end of the file is for the user of the module, the comment blocks at the top of each function are for the maintainer of the module (i.e. separate user versus maintainer documentation). The tricky bit is balancing this with DRY.


In reply to Re^2: flower box comments by eyepopslikeamosquito
in thread flower box comments by mandog

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 avoiding work at the Monastery: (8)
As of 2024-04-25 11:34 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found