Welcome to the Lounge
For lazing about and discussing anything in a software developer's life that takes your fancy.
The Lounge is rated PG. If you're about to post something you wouldn't want your kid sister to read then don't post it. No flame wars, no abusive conduct and please don't post ads.
Technical discussions are welcome, but if you need specific help please
use the programming forums.
|
|
 |
|
Is it as harmful as Dihydrogen Monoxide?[^]
====================================
Transvestites - Roberts in Disguise!
====================================
|
|
|
|
|
|
YvesDaoust wrote: This way to document software drives me mad. It forces you to scan the whole API before you know if the functionality suits your needs, and gives you no hint on the philosophy of the stuff.
It creates a reference, which should be part of the documentation; allows for quick lookups on the API and the syntax, but is indeed a lousy way of communicating it's use.
Bastard Programmer from Hell 
if you can't read my code, try converting it here[^]
|
|
|
|
|
|
YvesDaoust wrote: bloody, endless, uninformative Class Reference
Well, that's exactly what it is, so no problem.
What it is not is a user guide/programming guide, so don't expect it to be one, but do complain if there isn't one.
The general process is that developers refer to a user guide/programming guide until they've had a bit of practice, and then almost exclusively use the class reference. That's just how it works.
Without the kick start of a user guide/programming guide, though, a class reference is just a pain in the @rse.
I wanna be a eunuchs developer! Pass me a bread knife!
|
|
|
|
|
|
Mark Wallace wrote: bloody, endless, uninformative Class Reference
Well, that's exactly what it is, so no problem.
Well, there is in fact a problem if the class reference is, as the OP said, uninformative, and most are. Constructor documentation that says "Instantiates a new instance of MyClass." is as useful as a chocolate teapot.
|
|
|
|
|
... because of all the "Clicking the Print button prints the document" boilerplate.
The problem here is that typical programmers aren't used to documentation, don't read documentation, much less their own. Don't blame the tool, blame the tool.
|
|
|
|
|
You said the right thing(s).
|
|
|
|
|
Answer: 27
How old was I when I last spent a week sober? No, that is not the question, but what is ...
Panic, Chaos, Destruction. My work here is done.
Drink. Get drunk. Fall over - P O'H
OK, I will win to day or my name isn't Ethel Crudacre! - DD Ethel Crudacre
I cannot live by bread alone. Bacon and ketchup are needed as well. - Trollslayer
Have a bit more patience with newbies. Of course some of them act dumb - they're often *students*, for heaven's sake - Terry Pratchett
|
|
|
|
|
|
|
General 
News 
Suggestion 
Question 
Bug 
Answer 
Joke 
Rant 
Admin
Submit an article or tip
Post your Blog
