Eclipse newbie: How to add Javadoc?

Posted on 2006-04-17
Medium Priority
Last Modified: 2011-09-20
Dear Eclipse Experts,

I'm sure I'm missing something obvious here...

In JBuilder, I could just right-click class declarations and methods, and a nice add-Javadoc window would pop up.  Is there anything similar in Eclipse?  Or do I have to hand-code it?

Question by:BrianMc1958
  • 2
  • 2
LVL 10

Expert Comment

ID: 16471771
Surely that feature is there in Eclipse. You can right click on the class/method/field declaration
in the outline or anywhere else and got to Source -> Add JavaDoc Comment.

There is a shortcut too.. Alt + Shift + J


Author Comment

ID: 16471875
When I do that, I automitcally get this:

 * @author Administrator

I actually want to put in a "@todo", and I'd like it to be part of the existing JavaDoc for the class.  Is there a way to do that?  

LVL 10

Accepted Solution

radarsh earned 500 total points
ID: 16471924
Yes you can do that by editing templates.
Go to Window -> Preferences -> Java -> ... Templates
(I don't remember the exact location... but it's somewhere inside Java)

There, under comments, you'll find many existing templates. Edit the one for new types and
put in whatever you want to.


Author Comment

ID: 16471948
Thanks.  I'll take a look at it...


Featured Post

Industry Leaders: We Want Your Opinion!

We value your feedback.

Take our survey and automatically be enter to win anyone of the following:
Yeti Cooler, Amazon eGift Card, and Movie eGift Card!

Question has a verified solution.

If you are experiencing a similar issue, please ask a related question

After being asked a question last year, I went into one of my moods where I did some research and code just for the fun and learning of it all.  Subsequently, from this journey, I put together this article on "Range Searching Using Visual Basic.NET …
This was posted to the Netbeans forum a Feb, 2010 and I also sent it to Verisign. Who didn't help much in my struggles to get my application signed. ------------------------- Start The idea here is to target your cell phones with the correct…
Viewers will learn about arithmetic and Boolean expressions in Java and the logical operators used to create Boolean expressions. We will cover the symbols used for arithmetic expressions and define each logical operator and how to use them in Boole…
This tutorial will introduce the viewer to VisualVM for the Java platform application. This video explains an example program and covers the Overview, Monitor, and Heap Dump tabs.
Suggested Courses
Course of the Month16 days, 11 hours left to enroll

862 members asked questions and received personalized solutions in the past 7 days.

Join the community of 500,000 technology professionals and ask your questions.

Join & Ask a Question