How about working it into the Live Templates somehow? Then everybody can tweak it to their heart's content.
Noah --- Jonas Envall <[EMAIL PROTECTED]> wrote: > Could we not have IDEA generate the stub and give a > warning until we > have written a comment for it. In my oppinion it > qualifies as an error > or at least a warning to leave it at: "* @param > myParameter1" without > the comment. It is quite boring though to have to > write @param etc each > time. > > /Jonas > > > Christian Andersson wrote: > > > > >>-----Original Message----- > >>From: Fredrik Lindgren > [mailto:[EMAIL PROTECTED]] > >>Sent: den 4 mars 2002 00:56 > >>To: [EMAIL PROTECTED] > >>Subject: Re: [Eap-features] automatic javadoc > >> > >> > >>Why do you want this feature? Is there any > information added in that > >>piece of javadoc that was not already obvious from > the method > >>signature? > >> > > > >Quite easy, I would like Idea to help me write a > proper javadoc comment. > >(I can not say I'd like my comment template look > like exactly as Juhana specified.) > >Idea should assist me in writing a full and > complete proper javadoc comment. Help me in the ways > it can to write a well written comment useful to > others. > >Sure, if you leave your comment as proposed not > adding any information yourself, then of course you > will end up with nothing more than the method > specification. But then you have the option of not > writing any comment at all, don't you? > > > > /** > > * | > > * @param myParameter1 > > * @param myParameter2 > > * @return > > * @throws myException > > */ > > public int myMethod(int myParameter1, int > myParameter2) throws MyException { > > ... > > } > > > >For those who would like to read about how a > comment should be written: > >http://java.sun.com/j2se/javadoc/writingdoccomments/index.html > >http://java.sun.com/j2se/javadoc/writingapispecs/index.html > >http://java.sun.com/j2se/javadoc/faq.html > > > >/Christian > >PS. > > There could be a user template for the comment > "body". > > Where you could add your line: > > <!-- Undocumented method added by $USER$ on $DATE$ > --> > >DS. > > > > > >>I would much prefer an option to generate the > following > >>javadoc to any > >>newly created undocumented public method: > >> > >>/** > >> * Undocumented method added by $USER$ on $DATE$ > >> */ > >> > >>I think that the probability for properly > documented code is > >>higher in > >>this case since undocumented methods would not > pass undetected by > >>looking like documented methods > >> > > > >-1 ;) > > > >_______________________________________________ > >Eap-features mailing list > >[EMAIL PROTECTED] > >http://www.intellij.com/mailman/listinfo/eap-features > > > > > > > _______________________________________________ > Eap-features mailing list > [EMAIL PROTECTED] > http://www.intellij.com/mailman/listinfo/eap-features __________________________________________________ Do You Yahoo!? Yahoo! Sports - sign up for Fantasy Baseball http://sports.yahoo.com _______________________________________________ Eap-features mailing list [EMAIL PROTECTED] http://www.intellij.com/mailman/listinfo/eap-features
