Java Language Documentazione del pacchetto


Esempio

Java SE 5

È possibile creare documentazione a livello di pacchetto in Javadoc utilizzando un file chiamato package-info.java . Questo file deve essere formattato come di seguito. Spazi bianchi iniziali e asterischi facoltativi, tipicamente presenti in ogni riga per motivi di formattazione

/**
 * 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.

Nel caso precedente, devi inserire questo file package-info.java nella cartella del pacchetto Java com.example.foo .