Beefy Boxes and Bandwidth Generously Provided by pair Networks
good chemistry is complicated,
and a little bit messy -LW
 
PerlMonks  

Re^2: flower box comments

by eyepopslikeamosquito (Archbishop)
on Jun 21, 2021 at 02:17 UTC ( [id://11134097]=note: print w/replies, xml ) Need Help??


in reply to Re: flower box comments
in thread flower box comments

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.

Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Node Status?
node history
Node Type: note [id://11134097]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others examining the Monastery: (4)
As of 2024-04-20 04:05 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found