Alex,
2009/9/28 Alexander Kiel <[email protected]>:
> Hi Vincent,
>
>> However, new committed code is not supposed to break any rule, neither
>> warnings nor errors.
>
> Really? That means commenting every public method even simple Getters
> and Setters?
Yes. Simple Getter and Setters are the only place where you can
publicly document private variables. (in most cases, comment in the
getter and link from the setter)
> Commenting equals(), hashCode() and toString()? I think,
> this would be only clutter.
/** {...@inheritdoc} */
would do the trick on those, UNLESS they implement something which is
unexpected (such as the equals methods I recently renamed which did
not implement equals) or special (a toString which creates a
guaranteed parsable result for example)
> Best Regards
> Alex
hth
Max
