Esempio super-basilare:
Struttura file/directory:
XYZ/src/com/esempio/StringUtils.java
XYZ/doc
Nota 1: XYZ = una qualunque directory.
Nota 2: doc è inizialmente vuota.
StringUtils.java contiene:
codice:
package com.esempio;
/**
* La classe <code>StringUtils</code> contiene metodi di utilità
* per le stringhe.
*
* @author nomeautore
* @version 1.0
*/
public class StringUtils {
private StringUtils() {}
/**
* Rovescia il contenuto di una stringa.
*
* @param str la stringa in ingresso.
* @return la stringa rovesciata.
*/
public static String rovesciaStringa(String str) {
char[] buf = str.toCharArray();
for (int i = 0; i < buf.length/2; i++) {
char t = buf[i];
buf[i] = buf[buf.length-i-1];
buf[buf.length-i-1] = t;
}
return new String(buf);
}
}
Da prompt dei comandi, stando come directory "corrente" nella XYZ, dare:
javadoc -sourcepath src -d doc -author -version -subpackages com
Questo è già sufficiente per generare una documentazione javadoc.