Beefy Boxes and Bandwidth Generously Provided by pair Networks
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
in thread documentation generator? web-enabled perldoc? by geektron

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":



  • Are you posting in the right place? Check out Where do I post X? to know for sure.
  • Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
    <code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
  • Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
  • Want more info? How to link or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others goofing around in the Monastery: (6)
As of 2024-03-28 10:58 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found