이희승 (Trustin Lee) wrote:
On Fri, 23 May 2008 12:02:45 +0900, Emmanuel Lecharny
<[EMAIL PROTECTED]> wrote:
이희승 (Trustin Lee) wrote:
Every public methods except for the constructors are overridden from
its supertypes and interfaces. They all got proper JavaDoc
comments. Let me know if I am missing something.
Adding a @see Class#method() in the implementation then should help.
When you look at a method javadoc it's better to know where too look
at : the intheritance scheme can be feilry complex, and it can be a
burden to retreive the associated Javadoc.
Something like :
/**
* @see javax.naming.Context#close()
*/
public void close() throws NamingException
...
I'd just move the cursor on the method? That shows pretty nicely
rendered JavaDoc in modern IDEs. If you are interested in the class
hierarchy, press F4 in Eclipse. It's what IDEs are supposed to do and
they already do so.
I would also add that @see is really the bare minimum. It would be MUCH
better to copy/past the javadoc from the interface. Just have a look at
List and ArrayList, to check how it's done in Java code.
Note that I would understand that until the code is finished, copying a
bad javadoc is painfull, thus using the @see is a cool shortcut.
Thanks.
--
--
cordialement, regards,
Emmanuel Lécharny
www.iktek.com
directory.apache.org