Beefy Boxes and Bandwidth Generously Provided by pair Networks
Do you know where your variables are?
 
PerlMonks  

Re: Documentation

by seattlejohn (Deacon)
on Sep 26, 2002 at 23:28 UTC ( [id://201087]=note: print w/replies, xml ) Need Help??


in reply to Documentation

Well, I use POD/perldoc. I find it very appealing for the following reasons:
  • It's integral to the code (if I want it to be), so I'm less likely to forgot to update doc when I change the code.
  • POD can be exposed at run-time using modules like Pod::Usage -- so with just a little bit of planning, the documentation can double as help/manpage info for your users.
  • POD doesn't require any extra tools, which is nice if you're developing on and deploying to multiple systems.
  • It's easy to convert POD to plain text, HTML, and a variety of other output flavors.
  • Various Pod::* modules give me other ways to manipulate the POD contents. For example, I can write a pre-deployment check that makes sure my POD contains correct copyright notices and so on.

Of course, if there's something better out there I'd love to know about it too. But looking at the doc for RoboDoc -- I haven't actually used it -- makes it seem like it offers POD-like functionality but not a lot of extras that would compel me to switch.

Log In?
Username:
Password:

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

How do I use this?Last hourOther CB clients
Other Users?
Others learning in the Monastery: (9)
As of 2024-04-23 17:08 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found