Java Language link


Esempio

Il collegamento ad altri Javadoc è fatto con il tag @link :

/**
 * You can link to the javadoc of an already imported class using {@link ClassName}.
 *
 * You can also use the fully-qualified name, if the class is not already imported: 
 *  {@link some.other.ClassName}
 *
 * You can link to members (fields or methods) of a class like so:
 *  {@link ClassName#someMethod()}
 *  {@link ClassName#someMethodWithParameters(int, String)}
 *  {@link ClassName#someField}
 *  {@link #someMethodInThisClass()} - used to link to members in the current class
 *  
 * You can add a label to a linked javadoc like so:
 *  {@link ClassName#someMethod() link text} 
 */

cattura dello schermo del primo esempio

Con il tag @see puoi aggiungere elementi alla sezione Vedi anche . Come @param o @return il luogo in cui appaiono non è rilevante. Le specifiche dicono che dovresti scriverlo dopo @return .

/**
 * This method has a nice explanation but you might found further
 * information at the bottom.
 *
 * @see ClassName#someMethod()
 */

cattura dello schermo di esempio

Se si desidera aggiungere collegamenti a risorse esterne, è sufficiente utilizzare il tag HTML <a> . Puoi usarlo in linea ovunque o all'interno di entrambi i tag @link e @see .

/**
 * Wondering how this works? You might want
 * to check this <a href="http://stackoverflow.com/">great service</a>.
 *
 * @see <a href="http://stackoverflow.com/">Stack Overflow</a>
 */

cattura dello schermo di esempio di collegamento esterno