True in some cases. I actually don't like comments much, unless I'm trying to use someone else's API. A good API shouldn't require that I look at the code much, I should be able to use the API just from the javadocs. In particular, because Intellij pops up the quick javadocs in code completion, I've found myself using those docs more often lately.
I totally agree that auto-generated docs don't provide much useful info by themselves, so this is what I had in mind: a dialog similar to the override method dialog. Show me a list of methods and fields for which I have not yet provide javadocs, and let me highlight those I wish to generate them for. Presumably this will just generate skeletal information (all the javadoc fields which can be discovered from code), which I would then elaborate on.
I thought about whether I'd prefer an alt-insert generator, but I tend to finish all the coding first, then add comments last, so it would be nice to do them all in one fell swoop.
-----Original Message-----
From: Dmitry Jemerov [mailto:[EMAIL PROTECTED]]
Sent: Friday, November 02, 2001 4:06 PM
To: Egan, Russ
Subject: Re[2]: [Eap-list] Defining Javadoc templates for getters and
setters
Hello Russ,
Friday, November 02, 2001, 7:50:18 PM, you wrote:
ER> Another suggestion for handling javadocs:
ER> There's some beautifier (jindent I think) which will automatically generate
ER> javadocs for methods and fields which don't already have them. I think it
ER> set certain javadoc fields like author, exception, param, etc. It might
ER> also generate some simple text just describe the type and roughly where it's
ER> used. This is pretty darn useful, and might be a good alternative to
ER> template-based alt-insert (though that obviously has some other benefits).
As it has been discussed before, this is pretty darn useless. Such
javadocs create an illusion that information exists when really there
is none, and they just clutter the code.
A much better idea would be a javadoc template generator that works
only for a single method for which it was invoked.
--
Best regards,
Dmitry mailto:[EMAIL PROTECTED]
_______________________________________________
Eap-list mailing list
[EMAIL PROTECTED]
http://www.intellij.com/mailman/listinfo/eap-list
The information contained in this e-mail including any attachments may constitute Corvis Corporation Proprietary Information that is subject to Non-Disclosure Agreement and cannot be disclosed to any other party without the express consent of Corporation.
If you are neither the intended recipient of this e-mail nor responsible for delivering this e-mail to the intended recipient, note that any dissemination, distribution, copying, or retention of this e-mail is prohibited.
If you believe you have received this e-mail in error, we request that you notify the sender by return e-mail and then delete this mailand any return e-mail immediately.
