Displaying Javadoc Documentation While Editing


The IDE gives you a few ways to access documentation for JDK and library classes.

To glance at documentation for the currently selected class in the Source Editor, press Ctrl-Shift-spacebar. A popup window appears with the Javadoc documentation for the class. This popup also appears when you use code completion. You can dismiss the popup by clicking outside of the popup.

To open a web browser on documentation for the selected class, right-click the class and choose Show Javadoc (or press Alt-F1).

To open the index page for a library's documentation in a web browser, choose View | Documentation Indices and choose the index from the submenu.

Documentation for some libraries is bundled with the IDE. However, you might need to register the documentation for other libraries in the IDE for the Javadoc features to work. See Making External Sources and Javadoc Available in the IDE in Chapter 3 for more information.

Paradoxically, JDK documentation is available through a popup in the Source Editor but not through a browser by default. This is because the Javadoc popup in the Source Editor picks up the documentation from the sources that are included with the JDK. However, the browser view of the documentation requires compiled Javadoc documentation, which you have to download separately from the JDK. See Referencing JDK Documentation (Javadoc) from the Project in Chapter 3.




NetBeans IDE Field Guide(c) Developing Desktop, Web, Enterprise, and Mobile Applications
NetBeans IDE Field Guide(c) Developing Desktop, Web, Enterprise, and Mobile Applications
ISBN: N/A
EAN: N/A
Year: 2004
Pages: 279

flylib.com © 2008-2017.
If you may any questions please contact us: flylib@qtcs.net