Skip to Content
NetBeans: The Definitive Guide
book

NetBeans: The Definitive Guide

by Tim Boudreau, Jesse Glick, Simeon Greene, Vaughn Spurlin, Jack J. Woehr
October 2002
Intermediate to advanced
672 pages
21h 47m
English
O'Reilly Media, Inc.
Content preview from NetBeans: The Definitive Guide

Chapter 10. Using Javadoc

Javadoc Support in NetBeans

All programmers are familliar with code commenting. The Java language supports C-style code commenting (/* and */ for multiline comments and // for single-line comments) plus an additional commenting style called “doc comments.” A doc comment in a Java source file begins with /** (note the double asteriks) and ends with */. These comments are viewed as regular comments by the compiler, but the javadoc tool can be used to parse them and produce an HTML document known as a Javadoc.

Because doc comments are used to produce HTML they can contain HTML markup tags. Typically these are HTML formatting tags such as <B> and <I>. There are also several special non-HTML tags that can be used. For more information on the javadoc tool and the Javadoc tags see The Javadoc Tools Homepage (http://java.sun.com/j2se/javadoc/).

The javadoc tool has been fully integrated into the NetBeans IDE. Developers can search and browse Javadoc libraries (JAR files or folders containing Javadoc HTML files), get context-sensitive Javadocs, add and verify Javadoc tags to their code, and create Javadocs from their source code using the IDE’s Javadoc features.

Mounting Javadocs

Tip

The Javadoc Repository will be removed in NetBeans 3.4.

Before you can search and browse Javadocs, they must be mounted in the Javadoc repository. NetBeans maintains a separate repository for each project you create. The repository contains folders and JAR files that contain Javadocs ...

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.

Read now

Unlock full access

More than 5,000 organizations count on O’Reilly

AirBnbBlueOriginElectronic ArtsHomeDepotNasdaqRakutenTata Consultancy Services

QuotationMarkO’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.
Julian F.
Head of Cybersecurity
QuotationMarkI wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.
Addison B.
Field Engineer
QuotationMarkI’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.
Amir M.
Data Platform Tech Lead
QuotationMarkI'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.
Mark W.
Embedded Software Engineer

You might also like

Java EE 7 Development with NetBeans 8 - Third Edition

Java EE 7 Development with NetBeans 8 - Third Edition

David R Heffelfinger

Publisher Resources

ISBN: 0596002807Errata Page