[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
|
AW: [riena-dev] Suggestion: avoid "@see xyz"-only comments
|
> If only Eclipse would support the {@inheritDoc} tag properly, the follwing style would probably give us the best of both worlds:
> /*
> * {@inheritDoc}
> * @see org.eclipse.riena.ui.ridgets.IRidget#updateFromModel()
> */
BTW {@inheritDoc} has just been fixed in Eclipse 3.5 M1. See here:
http://download.eclipse.org/eclipse/downloads/drops/S-3.5M1-200808071402/3.5M1/eclipse-news-M1.html#JDT
Personally, I prefer the 'no comment' style for methods that just implement from the interface because it needs less lines.
> public void updateFromModel() {
The original text from the parent/interface will be inherited anyway. And when editing (in Eclipse) there is a up-arrow on the left of the method name, indicating it is implementing/overriding another method.
However I am ok with _any_ comment style that does not interfere the Eclipse "javadoc hover tooltip". That is my mean reason for not liking the /** @see */ style.
Kind regards,
Elias.
