"be consistent" | |
PerlMonks |
Re: avoiding writing readme for scriptsby arturo (Vicar) |
on Oct 16, 2000 at 18:47 UTC ( [id://36917]=note: print w/replies, xml ) | Need Help?? |
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
In Section
Seekers of Perl Wisdom
|
|