Do you know where your variables are? | |
PerlMonks |
Re: The problem of documenting complex modules.by karlgoethebier (Abbot) |
on Jul 10, 2015 at 19:06 UTC ( [id://1134233]=note: print w/replies, xml ) | Need Help?? |
"...they don't have a simple in; a clearly defined and obvious starting point that gives a universal starting point on which the new user can build." This is nothing but the truth. It seems like there is a tendency on CPAN that the documentation of some modules is written in a disastrous style. Just good for some initiated who know what to do. But compared to the documentation of less or more complex modules/classes in other languages, especially a certain language i think that we still live in the Garden of Eden. I don't know if you program in Java (unfortunately i'm forced to do it now). If not please try to figure out some stuff in this language. A very special experience. I guess you will land on some websites that just show that crap from javadoc. Next step: go to Oracle's Java Tutorial Site. Then go to Stackoverflow and continue. Now buy a book. Steps are interchangeable. No JavaMonks. That was it. I wish you well ;-) Best regards, Karl P.S.: IMHO another example of good documentation of complex stuff at MCE by marioroy. «The Crux of the Biscuit is the Apostrophe»
In Section
Meditations
|
|