Java By Comparison

Structure JavaDoc of Packages

/**
 * This package called logistics contains classes for logistics.
 * The inventory class in this package can stock up from the cargo ship and
 * dispose of any contaminated supplies.
 * Classes of this package:
 * - Inventory
 * - Supply
 * - Hull
 * - CargoShip
 * - SupplyCrate
 *
 * @author A. Lien, H. Uman
 * @version 1.8
 * @since 1.7
 */
package logistics;

JavaDoc^[26] is the documentation facility for APIs in Java. You use it to document anything that’s public in your code, including packages. If you’re writing an API and you want others to use it, that’s a must.

Here we have the JavaDoc of the logistics package.^[27] At first glance, the JavaDoc comment above ...