[Java] Javadoc verwenden

Zur Softwaredokumentation von Java-Quelltext eigenet sich hervorragend Javadoc.
Eine Dokumentation dazu ist auf www.oracle.com zu finden. Eine Kurzbeschreibung ist auch auf www.wikipedia.org vorhanden.

/**
 * Beschreibungstext<br>
 * <p>
 * Beschreibungstext
 *
 * @param  par1 dies ist Parameter1
 * @param  par2 dies ist Parameter2
 * @return      Rückgabeparameter
 * @see         Verweis
 */
public String getText(String par1, int Par2) {
        return null;
}