These two targets are described in the following sections. Thus, there are commonly two different ways to write doc comments - as API specifications, or as programming guide documentation. We spend time and effort focused on specifying boundary conditions, argument ranges and corner cases rather than defining common programming terms, writing conceptual overviews, and including examples for developers.

To this end, our target audience is those who write Java compatibility tests, or conform or re-implement the Java platform, in addition to developers. Our documentation comments define the official Java Platform API Specification. Troubleshooting Curly Quotes (Microsoft Word)Īt Java Software, we have several guidelines that might make our documentation comments different than those of third party developers.Tag Conventions ( Documenting Default Constructors.For the required semantic content of documentation comments, see Requirements for Writing Java API Specifications.

For reference material on Javadoc tags, see the Javadoc reference pages.

It does not rehash related material covered elsewhere: This document describes the style guide, tag and image conventions we use in documentation comments for Java programs written at Java Software, Oracle.

Links in description