Beefy Boxes and Bandwidth Generously Provided by pair Networks
There's more than one way to do things
 
PerlMonks  

Re^2: (How) Do you document/test your private subroutines?

by stevieb (Canon)
on Nov 06, 2018 at 23:58 UTC ( [id://1225338]=note: print w/replies, xml ) Need Help??


in reply to Re: (How) Do you document/test your private subroutines?
in thread (How) Do you document/test your private subroutines?

Thanks hippo,

I agree that the 'rules' are fast and far between for private subs. My private subs are, well, I wouldn't go as far as to say completely 'eloquent', but are typically self-documenting, especially for myself or any collaborators six months down-the-road.

That said, sometime's I'll add a specific section of documentation in POD (or otherwise) that doesn't exactly list/describe the sub in question, but does include developer-exclusive information in documentation that if they get deep enough, will find and be able to understand what private subs are required by higher-level ones, and easily (hopefully) figure out how they hang together.

  • Comment on Re^2: (How) Do you document/test your private subroutines?

Log In?
Username:
Password:

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

How do I use this?Last hourOther CB clients
Other Users?
Others meditating upon the Monastery: (5)
As of 2024-04-23 15:25 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found