commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sebb <seb...@gmail.com>
Subject Re: [math] Inherits doc and @Override
Date Mon, 25 Jul 2011 09:56:59 GMT
On 25 July 2011 09:13, Torsten Curdt <tcurdt@vafer.org> wrote:
>> Here's the problem as I see it.  Code with no javadoc is bad, bad,
>> bad.

+1

> Good code needs little javadocs.

I disagree strongly.

The Javadoc should present the public API (and should ideally be
written before the code - i.e. the code implements the docs).

If the only documentation is the code, it is much harder for users to
determine how to use the API.

For some code (interfaces, abstract methods) only Javadoc is available.

>
>  http://vafer.org/blog/20050323095453/
>
> Good docs and good code over noise - any time.

> cheers,
> Torsten
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Mime
View raw message