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 don't think that any of the developers in the project have looked at the extracted documentation more than once.

I think it's totally irrelevant if they looked at the extracted documentation or not - the question is if they looked at it all. If they read it inline in the source code you just wasted one run of your extraction script.

If they didn't look at it at all, you'd better spend your time with writing tests instead of documentation. Tests also document things in a way, and are more valuable if your colleagues don't look at the docs.

BTW I was a bit confused, because you seem to be talking about code that is neither visible to a customer (through an API or a command line interface), nor regarded as "re-usable", because after your own logic, code has to be documented if it meets either of these two criteria. If you have large amounts of code meeting none of these criteria, chances are that documentation isn't your biggest problem at all.


In reply to Re: What is your practice for code documentation? by moritz
in thread What is your practice for code documentation? by ady

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 browsing the Monastery: (4)
As of 2024-03-28 22:37 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found