Javadoc : écriture des liens aux méthodes

Question

Comment puis-je utiliser le `` tag pour poster un lien vers une méthode ?

Je veux changer

À

mais je ne sais pas comment mettre en forme le `` tag correctement.

Answer 1

Vous trouverez beaucoup d'informations sur la JavaDoc à la JavaDoc de référence de l'Outil page, y compris les informations sur l' {@link paquet.classe#label membre} tag (que vous recherchez):

Par exemple, voici un commentaire qui fait référence à la getComponentAt(int, int) méthode:

Use the {@link #getComponentAt(int, int) getComponentAt} method.

---

Autres liens utiles à propos de JavaDoc sont:

• JavaDoc De La Technologie
• Comment Écrire de la Doc Commentaires pour l'Outil Javadoc

Answer 2

Le format général, de l' @lien de la section de la documentation javadoc, est

{@link paquet.classe#label membre}

• Package est facultatif pour les classes du même package, et pour les classes importées.
• La classe est facultatif pour les méthodes de la même classe.
• Membre est le nom de la méthode et de sa signature.
• L'étiquette est en option. Si ce paramètre est spécifié, il remplace la signature de la méthode dans la documentation générée.

Pour exemple, voici un lien pour une méthode d'accepter un argument de type Chaîne, dans la même catégorie:

/** See also the method {@link #myMethod(String)}. */
void foo() { ... }

Pour une méthode dans une différente classe, soit dans le même colis ou importés:

/** See also the method {@link MyOtherClass#myMethod(String)}. */
void foo() { ... }

Pour une méthode dans une classe différente, dans un package différent et non importées:

/** See also the method {@link com.mypackage.YetAnotherClass#myMethod(String)}. */
void foo() { ... }