[MO-java-users] RE: [MO-java-dev] Javadoc is now online...

[Tim M. <tim...@po...>]

oooh catty.... I can feel the scratches ;-)

Yes - I personally think that docs are a crutch for writing bad code. I've
tried both and run the experiments and found that if I just wrote better
code, had better method names, better variable names and better examples and
tests - then the documents needed were very rudimentary. Yes its hard - but
it pays off (the result being better code ).

I would prefer people spend effort on a Q&A or a short article than write
java doc - maybe its a smalltalk thing - once I've got past the introduction
and seen an example I'm quite happy to browse working code that I know is up
to date.

We seem to disagree on this Vincent - but for all of your feedback on
requests for documentation I have tried to diligently go back to the code
and fix what was a problem there in the first place.

But maybe we do need some documentation that says:

- How to install it
- Which example to look at first
- What to do next
- How to read the code and use it as the documentation


Tim

> -----Original Message-----
> From: moc...@li...
> [mailto:moc...@li...]On Behalf Of
> Vincent Massol
> Sent: 03 June 2003 08:59
> To: moc...@li...
> Cc: 'Mockobjects-Java-Dev'
> Subject: [MO-java-dev] Javadoc is now online...
>
>
> FWIW, I've put the javadoc online:
>
> http://www.mockobjects.com/wiki/Javadocs
>
> Note: The MockObjects team thinks that javadoc is not needed and that
> good code should generally not need javadoc (i.e. it should be
> sufficiently expressive by itself). Thus you will find that this javadoc
> will not give you any explanation at all! In order to get explanation
> you are invited to read the code :-)
>
> Thanks
> -Vincent
>
>
>
> -------------------------------------------------------
> This SF.net email is sponsored by: eBay
> Get office equipment for less on eBay!
> http://adfarm.mediaplex.com/ad/ck/711-11697-6916-5
> _______________________________________________
> Mockobjects-java-dev mailing list
> Moc...@li...
> https://lists.sourceforge.net/lists/listinfo/mockobjects-java-dev
>
> ---
> Incoming mail is certified Virus Free.
> Checked by AVG anti-virus system (http://www.grisoft.com).
> Version: 6.0.487 / Virus Database: 286 - Release Date: 01/06/2003
>
---
Outgoing mail is certified Virus Free.
Checked by AVG anti-virus system (http://www.grisoft.com).
Version: 6.0.487 / Virus Database: 286 - Release Date: 01/06/2003