Problems? Is your data what you think it is? | |
PerlMonks |
comment on |
( [id://3333]=superdoc: print w/replies, xml ) | Need Help?? |
I asked a similar question in the chatterbox when I took on a large project, and I was also dismayed at the responses.
I think what we are looking for is a nice, standard way to document functions, modules, classes, and files. I'm not talking about the quality of documentation on most perl modules in CPAN (at least most of the ones I've used so far). I'm talking about an "allowed" argument list for each function, the return value, what it's used for, etc. You can surely document those in POD, but if you come up with a standard way of doing it (like, specifying that the first argument should be an integer, the second an array reference, and the third a string), you can use a source code analyzer or something to print pretty HTML docs similar to PHPDOC or JAVADOC. Of course as mentioned above, perl allows you to create functions that don't actually exist anywhere in source code, so you have to find some way to document those as well. I actually didn't find a good solution, so I'm just writing it all in POD with plain text and nice formatting. In reply to Re: documentation generator? web-enabled perldoc?
by saberworks
|
|