Name: dk30142 Date: 11/02/98


Javadoc text conventions are to use 3rd-person
declarative, not 2nd-person imperative.
The @return tag is inconsistent with this approach,
and is also inconsistent with other tags such
as @throws which do use 3rd-person declarative.
@returns should be introduced as a synonym for
for @return.
If the idea behind using @return rather than
@returns is to make tag names match java keywords,
I believe this is misguided, since there
is no natural mapping between tag names and
java keywords in general, eg. @param.
Regards,
Paul Ostler
Chief Architect
InterBase InterClient
(Review ID: 41901)
======================================================================