Saturday, August 12, 2017

How to Check Java Documentation of a Class in Netbeans IDE

Recently I have downloaded Netbeans IDE 7.0 to learn its GUI builder Matisse and I was impressed with the changes I saw in the Netbeans from my last use of it in 2007. I was a hardcore Netbeans fan when I was developing mobile application using J2ME and Netbeans integrated environment with WTK, Profiler, and Network Monitor just rocks and on top of that they had conditional compilation feature based on type of platform you   were working like you could maintain your code easily even if you are using device-specific libraries e.g. Nokia UI library etc. Anyway, those were the things of past, what attracted me is the Javadoc feature of Netbeans. Though this feature might have existed long back I have just started using it. Earlier to see Javadoc I used to Google and then go to Sun (now Oracle) website to view Javadoc of any class. While playing with Netbeans I discovered that you can easily Javadoc in the Netbeans IDE itself no need to visit the web.

There are multiple ways to see Javadoc in Netbeans:

1) Select any java class and right click you will see an option "Show Javadoc" which will open the Javadoc in a browser. You can also use the keyboard shortcut "alt+F1" to do this fast. You can also learn my favorite eclipse keyboard shortcut here.

2) By using JavaDoc Index Search: Javadoc index search is another cool feature provided by Netbeans IDE which is allowed to search for any Java class or interface or anything and display the result in the same window. To open Javadoc index search window go to Help --> Java Doc Index Search option or press keyboard shortcut "Shift + F1"

3) By opening Javadoc window in Netbeans:  to open Javadoc window in Netbeans go to Window--> Others--> Javadoc and this will open Javadoc window which is the perfect way of seeing java doc along with writing code.

Another cool feature of this Javadoc window is you just need to focus on any java class it will automatically show the Javadoc for that class. It also provides buttons to move back and forward for easy navigation and best is yet to say you can open the source file of that java class right in front of you by click button "Open Source in editor" simply awesome isn't it.

Though I have been using Eclipse from past few years I must say some of Netbeans IDE feature is simply great. One of them is there Swing GUI builder and the other one I like is there Javadoc integration in IDE.

On a side note, Javadoc just comes integrated to me because I have downloaded JDK1.6+ Netbeans 7 bundle but in case you want to add Javadoc for some other API or platform, you can easily do this by following below Steps

Adding Javadoc in Netbeans IDE

  1. Go to Tools--> Java Platform It will open Java platform manager.
  2. Select the Java platform for which you want to add Javadoc could be J2ME also.
  3. Click on Javadoc tab and then just click the button Add Zip/Folder, point out your already downloaded Javadoc and you are done.

That’s all on how to check Javadoc for a class or method in Netbeans IDE. Though, I am primarly a Eclipse user and I have shared a lot of Eclipse tips and tricks, I ocassionaly also use Netbeans, mainly for Java web application development because it offer truly integrated environment without too much fush and plugins you need to setup in Eclipse.

Related post:
How to setup java remote debugging in Eclipse
10 practical tips on Java debugging with eclipse
Top 20 Eclipse IDE keyboard shortcuts
Java swing tutorial: Learning JList with code example
How to convert String to Integer to String in Java example
How to use jdk7 multi-cache block with an example
String vs StringBuffer vs StringBuilder in Java
How to resolve java.lang.UnsupportedClassVersionError with example

Thanks for reading this article so far. If you like this NetBeans Tips then Please share with your friends and colleagues. If you have any questions or feedback then please drop a note. 

1 comment :

Unknown said...

What about javadoc in netbeans with UMLGraph?

Post a Comment