commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Jörg Schaible <joerg.schai...@scalaris.com>
Subject Re: [math] Inherits doc and @Override
Date Mon, 25 Jul 2011 05:52:53 GMT
Hi Phil,

Phil Steitz wrote:

> On 7/24/11 3:13 PM, Gilles Sadowski wrote:
>> Hello.
>>
>>> I saw in the sources serveral /** {@inheritDoc} */ on methods with
>>> @Override annotation. Javadoc knows to inherit the javadoc of the
>>> overwritten methos, so there is no need for @inheritDoc.
>>> If all agree, one could drop this if the code is modified?
>> CheckStyle complains if there isn't a Javadoc block.

Bad argument. Adjust the rule.

> Right, and including it creates a placeholder to expand on or modify
> the inherited javadoc.  I think we should keep it.

We finally removed it in our code base here at my company and it looks so 
much cleaner. Why keep superfluous lines of "boiler plate stuff" without any 
relevance? If there is something to document on, I'd expect a little more 
than {@inheritDoc} anyway.

- Jörg


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


Mime
View raw message