cargofere.blogg.se

The Java Platform API Specification is a contract between callers and implementations. In particular, specifications that are lengthy are sometimes best formatted in a separate file and linked to from a doc comment. Notice that the specification does not need to be entirely contained in doc comments. The Java Platform API Specification is defined by the documentation comments in the source code and any documents marked as specifications reachable from those comments. The following are guiding principles we try to follow:

This definition is a lofty goal and there is some practical limitation to how fully we can specify the API. This may include assertions in the doc comments plus those in any architectural and functional specifications (usually written in FrameMaker) or in any other document. Ideally, the Java API Specification comprises all assertions required to do a clean-room implementation of the Java Platform for "write once, run anywhere" - such that any Java applet or application will run the same on any implementation. This is why developers often need to turn to other documents, such as Java SE Technical Documentation and The Java Tutorials for programming guides. A staff with generous resources can afford to blend both into the same documentation (properly "chunked") however, our priorities dictate that we give prime focus to writing API specifications in doc comments. 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.