Java Language Documentation du package


Exemple

Java SE 5

Il est possible de créer une documentation au niveau du package dans Javadocs à l'aide d'un fichier appelé package-info.java . Ce fichier doit être formaté comme ci-dessous. Les espaces blancs et les astérisques sont facultatifs, généralement présents dans chaque ligne pour la raison du formatage

/**
 * Package documentation goes here; any documentation before the first period will 
 * be used as a summary.
 *
 * It is common practice to leave a blank line between the summary and the rest
 * of the documentation; use this space to describe the package in as much detail
 * as is appropriate.
 * 
 * Inline tags such as {@code code here}, {@link reference.to.other.Documentation},
 * and {@literal text here} can be used in this documentation.
 */
package com.example.foo;

// The rest of the file must be empty.

Dans le cas ci-dessus, vous devez placer ce fichier package-info.java dans le dossier du package Java com.example.foo .