Why not a compromise?  Like this would be the result:

/**
  * Undocumented method added by $USER$ on $DATE$
  * 
  * @param foo
  * @param bar
  * @returns baz
  */

That way not only is the 'grunge' work done for you, but it's also clearly
marked as undocumented.

Of course, I also want a way to keep the @param/@returns stuff "in sync"
with changes.  But then I want that all over (with try/catch, the throws
clause, imports, etc.) 


-----Original Message-----
Date: Mon, 04 Mar 2002 00:56:18 +0100
From: Fredrik Lindgren <[EMAIL PROTECTED]>
To: [EMAIL PROTECTED]
Subject: Re: [Eap-features] automatic javadoc
Reply-To: [EMAIL PROTECTED]

Instead of the usual -1 this kind of auto-javadoc feature request 
usually gets on the list (have a look at the archives) I would like to 
respond with a question:

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?

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


/Fredrik

_______________________________________________
Eap-features mailing list
[EMAIL PROTECTED]
http://www.intellij.com/mailman/listinfo/eap-features

Reply via email to