Your right, I asked before i realized that javadoc could be launched against a 
class with no comments at all.  It was my erroneous understanding that you 
needed 

/**
 * whatever whatever
 * whatever whatever
 */

in your code before javadoc could be generated.. 




-----Original Message-----
From: Brett Connor [mailto:[EMAIL PROTECTED]
Sent: Thursday, June 09, 2005 11:31 AM
To: Struts Users Mailing List
Subject: Re: [OT] Automatic Javadoc - ing


From: "Brian McGovern" <[EMAIL PROTECTED]>

>>I want to add javadoc comments to all my classes.. but am looking for a
>>    
>>
>way to do this automatically.
>  
>

What's the point? Until there is an automatic tool that adds a useful 
description based on an understanding of a class's responsibilities, a 
methods pre and post conditions (or is that what you're asking?),
I don't see that

/**
 * @param foo
 * @param bar
 * @return
 */
public int doFooBar(Something Foo, String bar)...

is any more useful than

public int doFooBar(Something Foo, String bar)...

Javadoc will automatically generate parameter names and types anyway.

Just my humble opinion.

Brett Connor


---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]


---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to