Java Answers Forum - How to make javadoc comments in my sources quickly?

Articles |
News |
Weblogs |
Books |
Forums

Artima Forums | Articles | Weblogs | Java Answers | News

Sponsored Link •

Java Answers Forum
How to make javadoc comments in my sources quickly?

3 replies on 1 page. Most recent reply: Mar 27, 2003 11:58 AM by Mike Johnson

Welcome Guest
Sign In

Back to Topic List

Reply to this Topic

Search Forum

Threaded View


Previous Topic		Next Topic

Flat View: This topic has 3 replies on 1 page

John

Posts: 1
Nickname: rjohn
Registered: Mar, 2003

How to make javadoc comments in my sources quickly?

Posted: Mar 27, 2003 5:54 AM

How to make javadoc comments in my sources quickly?
For example I have source

public class a
{
public static void main(String arg[])
{
...
}
}

Is exists tool that can convert it to:

/**
*
*/
public class a
{
/**
*
* @param arg description for arg.
*/
public static void main(String arg[])
{
...
}
}

Sergey

Posts: 1
Nickname: sergey
Registered: Mar, 2003

Re: How to make javadoc comments in my sources quickly?

Posted: Mar 27, 2003 8:29 AM

Try Actos Auto Commentator For Java
http://www.actos-lab.com/AC4J.html

Matt Gerrans

Posts: 1153
Nickname: matt
Registered: Feb, 2002

Re: How to make javadoc comments in my sources quickly?

Posted: Mar 27, 2003 11:52 AM

I think many of the nice editors/IDEs, like IntelliJ IDEA, NetBeans, Borland JBuilder, etc., will complete the comment header for you after you type '/**'. I don't know if they are all smart enough to fill in the @param and other parts, but I think most are. Some might even have a feature to generate comment header templates for all classes/public methods in existing files.

You can try all of these and more out for free (some like NetBeans are open source, so they remain free). Search for "Java IDE" on Google and you'll have plenty to try.

Mike Johnson

Posts: 1
Nickname: mrjohnson
Registered: Mar, 2003

Re: How to make javadoc comments in my sources quickly?

Posted: Mar 27, 2003 11:58 AM

Emacs + JDE does it pretty well for me, it's quick and unobtrusive.

On the other had, Emacs is a bit too much for people just starting. :-) I've also found that NetBeans is pretty straight-forward for that sort of thing...

Flat View: This topic has 3 replies on 1 page

Previous Topic

Next Topic


	Web Artima.com