I totally agree, such JavaDoc comments are entirely useless. In general, any kind of comment should only contain information that can not easily be gathered by looking at the source code. If it can not easily be gathered from the code, I would argue that in most cases, the code simply needs some refactorings such as rename method/variable, extract method and so on. In my opinion, comments are a bad code smell. They are only warranted in very few cases.
But, if somebody's coding standard calls for JavaDoc comments for EVERY method (sorry to hear that), then I guess such a tool would be very helpful for them. I would argue though that this should be resolved by bringing whoever is mandating such idiotic coding conventions into the 21st century. Kinda reminds me of my highschool programming teacher who taught me that every single line of code needs a comment... -Thomas > -----Original Message----- > From: Dmitry Jemerov [mailto:[EMAIL PROTECTED]] > Sent: Friday, November 02, 2001 1: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 > ************************************ If this email is not intended for you, or you are not responsible for the delivery of this message to the addressee, please note that this message may contain ITT Privileged/Proprietary Information. In such a case, you may not copy or deliver this message to anyone. You should destroy this message and kindly notify the sender by reply email. Information contained in this message that does not relate to the business of ITT is neither endorsed by nor attributable to ITT. ************************************ _______________________________________________ Eap-list mailing list [EMAIL PROTECTED] http://www.intellij.com/mailman/listinfo/eap-list
