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

Re: avoiding writing readme for scripts

by arturo (Vicar)
on Oct 16, 2000 at 18:47 UTC ( #36917=note: print w/replies, xml ) Need Help??


in reply to avoiding writing readme for scripts

I don't think you're going to get self-documenting code (how would you expect the code to know what it's doing, and be able to state that in a manner that the average user can understand?). You're going to have to write the documentation yourself. But there are tools to help you with that task.

One thing you can do is embed the documentation in the script itself, using POD (plain ol' documentation). That way, they can read up themselves by typing perldoc scriptname.pl

Read up on POD with man perlpod

Philosophy can be made out of anything -- or less

Log In?
Username:
Password:

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://36917]
help
Chatterbox?
[erix]: Peter's principle says it' sonly a matter of time ;)
[ambrus]: nah, I have sane bosses, I make my incompetence obvious, and have resistance myself.

How do I use this? | Other CB clients
Other Users?
Others exploiting the Monastery: (13)
As of 2017-09-22 14:03 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?
    During the recent solar eclipse, I:









    Results (264 votes). Check out past polls.

    Notices?