Beefy Boxes and Bandwidth Generously Provided by pair Networks
The stupid question is the question not asked
 
PerlMonks  

Re^2: The problem of documenting complex modules.(Summation.)

by hippo (Bishop)
on Jul 07, 2015 at 22:00 UTC ( [id://1133647]=note: print w/replies, xml ) Need Help??


in reply to Re: The problem of documenting complex modules.(Summation.)
in thread The problem of documenting complex modules.

... and that automated documentation al la doxygen, javadoc etc. is almost worse than none; as it gives the appearance of 'well documented' with none of the true benefits.

I could not agree more with this assertion. While such systems have one or two plus points (consistency of presentation, docs always in sync with code) this is usually far outweighed by the complete lack of any semantic meaning to the resulting documentation. There are no reasons given, no caveats, no SSCCEs, no algorithm references. And if/when the code author uses less than meaningful symbol names the whole exercise becomes pointless.

For the particularly complex dists which this thread addresses the resulting volume of brutalist formal data churned out by such auto-documenters is enough to send anyone scurrying for sanctuary. Fine for a reference no doubt, especially to those already well familiar with the dist in question, but not for the neophytes who are only after a gentle concept-based introduction.

  • Comment on Re^2: The problem of documenting complex modules.(Summation.)

Replies are listed 'Best First'.
Re^3: The problem of documenting complex modules.(Summation.)
by BrowserUk (Patriarch) on Jul 07, 2015 at 22:11 UTC
    far outweighed by the complete lack of any semantic meaning to the resulting documentation.
    the resulting volume of brutalist formal data churned out by such auto-documenters is enough to send anyone scurrying for sanctuary.

    The worst part in my experience is that their use serves as a ready justifiction for not providing anything else.

    It's like a car manufacturer supplying dealers with a comprehensive parts list, in place of Workshop manuals.

    No other industry would get away with the practice.


    With the rise and rise of 'Social' network sites: 'Computers are making people easier to use everyday'
    Examine what is said, not who speaks -- Silence betokens consent -- Love the truth but pardon error.
    "Science is about questioning the status quo. Questioning authority".
    In the absence of evidence, opinion is indistinguishable from prejudice.
    I'm with torvalds on this Agile (and TDD) debunked I told'em LLVM was the way to go. But did they listen!

Log In?
Username:
Password:

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

How do I use this?Last hourOther CB clients
Other Users?
Others having a coffee break in the Monastery: (8)
As of 2024-04-19 08:57 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found