Beefy Boxes and Bandwidth Generously Provided by pair Networks
Don't ask to ask, just ask
 
PerlMonks  

Re: [RFC] Review of module code and POD (Doco)

by eyepopslikeamosquito (Archbishop)
on Apr 01, 2021 at 00:32 UTC ( [id://11130653]=note: print w/replies, xml ) Need Help??


in reply to [RFC] Review of module code and POD

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:

Log In?
Username:
Password:

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

How do I use this?Last hourOther CB clients
Other Users?
Others sharing their wisdom with the Monastery: (2)
As of 2024-04-25 06:34 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found