-100 (let it be as it is)
As mentioned a couple of times ago, auto-generating of JavaDoc it very
useless, because one still needs to take a look at the method and decide,
what to put in the JavaDoc comment. What's the gain out of JavaDoc stub
that are lurking around in the project?
>I personally am really bad at writing comments (I'm sure I'm not alone)
>and additions like this provide facilities to make the job a little
>easier.
How can IDEA help you? How can IDEA detect, what the method should do? How
can IDEA detect, why the method is written as it is written?
If you want to take a look at how bad and useless auto-generated JavaDoc
comments are, take a look at some classes of the Netbeans project. Examples:
/** Holds value of property ignoreBlankLines. */
private boolean ignoreBlankLines;
/** Getter for property ignoreBlankLines.
* @return Value of property ignoreBlankLines.
*/
public boolean isIgnoreBlankLines() {
return this.ignoreBlankLines;
}
/** Setter for property ignoreBlankLines.
* @param ignoreBlankLines New value of property ignoreBlankLines.
*/
public void setIgnoreBlankLines(boolean ignoreBlankLines) {
this.ignoreBlankLines = ignoreBlankLines;
}
A lot of this text (I don't call it 'code') only clutters the files and
make them harder to read. In these cases it's 10 times better not to have
comments instead of such useless ones.
Best regards
Tom
At 11:39 23.03.2002 +0200, you wrote:
>I have mentioned this before but would like to bring it to the floor
>again.
>The auto generation of java stubs on all uncommented code is a great
>idea but is only REALLY usefull if you can add a template comment in
>such as "I still need to write a comment".
>I use xdoclet which has a @todo tag which would be great as part of the
>template so that writing the actual comments becomes part of the todo
>list.
>Using these helpful additions (or not) is a great way of finding your
>own balance between writing code and comments.
>I personally am really bad at writing comments (I'm sure I'm not alone)
>and additions like this provide facilities to make the job a little
>easier.
>
>Thanks
>
>On Fri, 2002-03-22 at 16:17, SyedA wrote:
> > Yes that is right. It would be nice especially if IDEA allows for more than
> > one file at a time, say through the project view.
> >
> > Amar Syed
> > Tel No: 02088965856
> > Mobile: 07092277786
> >
> >
> >
> >
> > -----Original Message-----
> > From: Serge Baranov [SMTP:[EMAIL PROTECTED]]
> > Sent: 22 March 2002 13:00
> > To: SyedA
> > Cc: [EMAIL PROTECTED]
> > Subject: Re: How do you generate auto class javadoc...
> >
> > Hello Amar!
> >
> > Do you mean automatic generation of javadoc stubs for the existing
> > classes/methods?
> >
> > Serge Baranov
> > JetBrains, Inc / IntelliJ Software
> > http://www.intellij.com
> > "Develop with pleasure!
> >
> > -----Original Message-----
> > From: "SyedA" <[EMAIL PROTECTED]>
> > Sent: Thursday, March 21, 2002, 12:58:48 PM
> > To: Serge Baranov
> > Subject: How do you generate auto class javadoc...
> >
> > I understand that currently you can generate Javadoc in HTML form to
> > a path
> > on the local machine. I was just wondering how can you get IDEA to
> > generate
> > javadoc for all the fields, constructors, methods etc inside the
> > source?
> >
> > Amar Syed
> > Tel No: 02088965856
> > Mobile: 07092277786
> >
> >
> >
> >
> > -----Original Message-----
> > From: ToprakE
> > Sent: 21 March 2002 09:30
> > To: SyedA
> > Subject: Intellij
> >
> > There is currently something really annoying me. Jbuilder had an
> > option to
> > java doc your *existing* class. Where is it on intellij??? Before
> > you say
> > it, I know Intellij does some automatically for *new* classes but
> > that just
> > doesn't help me....
> >
> > Ercan Toprak
> > Email: [EMAIL PROTECTED] <mailto:[EMAIL PROTECTED]>
> > Phone: +44 (0) 20 8896 5818 (I now have my number back!!!!!!!!!!)
_______________________________________________
Eap-features mailing list
[EMAIL PROTECTED]
http://www.intellij.com/mailman/listinfo/eap-features
