ditto. > -----Original Message----- > From: James Walker [mailto:[EMAIL PROTECTED]] > Sent: 04 December 2001 11:17 > To: [EMAIL PROTECTED] > Subject: RE: [Eap-features] Javadoc feature request. > > > We go as far as monitoring checkins of source which is missing JavaDoc > (not for privates, but for all public methods + class). > > We have templates which are applied to non-doced bitsies and > the templates > have stuff in them like "@param Blah XXX was lazy and will > fill this in later". > > JRefactory is the tool used btw. > > This is done prior to the standard checkin mailout which goes > to all other > members on the project. > > You can argue that it "fills the source with meaningless > comments" - but it > has resulted in much better documented code. > Previously people could let docs slip by and think about > "fixing them up > later", which of course never comes. > Now you either put up with having your name in lights, or you > do the right > thing and put at least a basic doc. > > I'd like to have something like the ability mentioned here, > where java docs > following certain templates are inserted either automatically > or on request > (part of the format source as well?). > > > > At 09:37 PM 4/12/2001, you wrote: > >Are you truing to say that you would fill afterwards EVERY > stupid field in > >this generated java doc? > >I don't believe it :) > > > >-----Original Message----- > >From: [EMAIL PROTECTED] > >[mailto:[EMAIL PROTECTED]]On Behalf Of Shabir, Nadeem > >Sent: Monday, December 03, 2001 11:53 PM > >To: '[EMAIL PROTECTED]' > >Subject: RE: [Eap-features] Javadoc feature request. > > > > > >I think I should have been more clear, Im not suggesting a > feature that > >writes the comment itself, > >but a feature that provides the stub so if a method takes a number of > >parameters and returns a type, it shouldnt be difficult for > intellij to > >generated a javadoc comment with only the @param and @return lists > >populated, it still means the developer has to write a > meaningful comment > >but at least the "stubs" are generated. > > > >I dont for one second believe any tool could generate > meaningful comments. > >But What would be useful is a tool that did the "leg work" > for us leaving > >developers to fill in the details. > > > >cheers, > > > >Nad > > > > > -----Original Message----- > > > From: Mark Swinkels [mailto:[EMAIL PROTECTED]] > > > Sent: 03 December 2001 21:51 > > > To: '[EMAIL PROTECTED]' > > > Subject: RE: [Eap-features] Javadoc feature request. > > > > > > > > > I think people have just stopped complaining about this > > > request. If you go > > > back through the archives you will see that there are > mostly lots of > > > negative responses to this feature. > > > > > > The negative responses all revolve around the problem of > > > developers not > > > going in after using this feature and making the generated > > > java docs useful. > > > A more generally accepted form of this proposal is that IDEA > > > provide help > > > for writing the javadoc for a particular method, rather than > > > adding them > > > wholesale. The help could include generating a skeleton and > > > provide tag > > > completion. In this way the developer can generate the > > > comments as they work > > > or generate them afterwards. If the comments are generated > > > automatically for > > > whole files or projects at a time the developer will have to > > > go in to edit > > > the all comments anyway. > > > > > > +1 for javadoc generation on a single method basis > > > +1 for a way to find methods that meet some criteria (e.g. > > > public) but don't > > > have Javadoc comments > > > -10 for a way to fill source files with meaningless comments > > > that don't > > > convey any information beyond the method signature yet have > > > to be read to > > > determine that fact. > > > > > > -----Original Message----- > > > From: Noah Nordrum [mailto:[EMAIL PROTECTED]] > > > Sent: Monday, December 03, 2001 09:44a > > > To: [EMAIL PROTECTED] > > > Subject: Re: [Eap-features] Javadoc feature request. > > > > > > > > > ok, this is like at least the 15th time I've seen this > request (not a > > > complaint to you Nadeem)... It is also one of the only > requests that I > > > haven't seen any complaints about. I can't imagine that this > > > would be a very > > > tough thing to implement. > > > > > > Could we PLEASE get this in Pandora? or as one of (or the) > > > first features in > > > the next EAP? > > > > > > Thanks, > > > Noah > > > > > > ----- Original Message ----- > > > From: "Shabir, Nadeem" <[EMAIL PROTECTED]> > > > To: <[EMAIL PROTECTED]> > > > Sent: Monday, December 03, 2001 5:57 AM > > > Subject: [Eap-features] Javadoc feature request. > > > > > > > > > > I dont know if anyone has already asked for this but it > > > would be very > > > > useful. > > > > > > > > What id like is a feature that would look at all the method > > > signatures, in > > > a > > > > file an insert javadoc comments infront of each method, but > > > pre-populating > > > > param and return lists based on the signature. This would > > > save a lot of > > > > time, ive used similar features in Kawa where it was > > > implemented as a > > > plugin > > > > that would pass through the file and do it for you. Im > not sure if > > > IntelliJ > > > > could also do something similar? > > > > > > > > Ive tried to create a live template to do this but > arent having much > > > > success. > > > > > > > > Any thoughts? > > > > > > > > cheers > > > > > > > > Nadeem > > > > > > > > > > > > Nadeem Shabir BSc > > > > Senior > > > > J2EE Developer > > > > > > > > Data Systems & Solutions (DS&S), > > > > PO Box No 31, > > > > Sinfin Lane, > > > > Derby. > > > > DE24 8BJ. > > > > > > > > www.ds-s.com > > > > > > > > Tel : (01332) 777570 > > > > Fax : (01332) 772647 > > > > Mobile: (07790) 901297 > > > > > > > > E-mail: [EMAIL PROTECTED] > > > > > > > > For optimum solutions that save you time, visit www.ds-s.com. > > > > > > > > _______________________________________________ > > > > Eap-features mailing list > > > > [EMAIL PROTECTED] > > > > http://www.intellij.com/mailman/listinfo/eap-features > > > > > > > > > _________________________________________________________ > > > Do You Yahoo!? > > > Get your free @yahoo.com address at http://mail.yahoo.com > > > > > > > > > _______________________________________________ > > > 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 > > > > >For optimum solutions that save you time, visit www.ds-s.com. > > > >_______________________________________________ > >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 > > -- > Stock Software Pty Ltd > > > _______________________________________________ > Eap-features mailing list > [EMAIL PROTECTED] > http://www.intellij.com/mailman/listinfo/eap-features > For optimum solutions that save you time, visit www.ds-s.com.
_______________________________________________ Eap-features mailing list [EMAIL PROTECTED] http://www.intellij.com/mailman/listinfo/eap-features
