Comment référencer une méthode dans la javadoc?

Comment puis-je utiliser le @link balise de lien à une méthode?

Je veux changer

/**
 * Returns the Baz object owned by the Bar object owned by Foo owned by this.
 * A convenience method, equivalent to getFoo().getBar().getBaz()
 * @return baz
 */
public Baz fooBarBaz()

/**
 * Returns the Baz object owned by the Bar object owned by Foo owned by this.
 * A convenience method, equivalent to {@link getFoo()}.{@link getBar()}.{@link getBaz()}
 * @return baz
 */
public Baz fooBarBaz()

mais je ne sais pas comment faire pour formater le @link balise correctement.

Je sais que c'est il y a quelques années mais... en regardant l'officiel des classes Java peut vous aider à trouver toute forme de Javadoc mise en forme dont vous avez besoin. Par exemple regardez la table de hachage Javadoc.

InformationsquelleAutor Jason S | 2011-05-06

998

Vous trouverez beaucoup d'informations sur la JavaDoc à la Commentaire de Documentation de Spécification pour le Doclet Standard, y compris les informations sur les

{@link paquet.classe#label membre}

tag (que vous recherchez). L'exemple correspondant à partir de la documentation est comme suit

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

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

La package.class partie peut être omis si la méthode est dans le courant de la classe.

D'autres liens utiles à propos de JavaDoc sont:
InformationsquelleAutor FrVaBe
672

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

Exemples

Méthode de la même classe:
```
/** See also {@link #myMethod(String)}. */
void foo() { ... }
```
Méthode dans un classe différente, soit dans le même emballage ou importés:
```
/** See also {@link MyOtherClass#myMethod(String)}. */
void foo() { ... }
```
Méthode dans un les différentes et non importées:
```
/** See also {@link com.mypackage.YetAnotherClass#myMethod(String)}. */
void foo() { ... }
```
Étiquette liée à la méthode, en texte brut plutôt que de la police de code:
```
/** See also this {@linkplain #myMethod(String) implementation}. */
void foo() { ... }
```
Une chaîne d'appels de méthode, que dans votre question. Nous avons à spécifier des étiquettes pour les liens vers des méthodes en dehors de cette classe, soit on se getFoo().Foo.getBar().Bar.getBaz(). Mais ces étiquettes peuvent être fragiles; voir "Étiquettes" ci-dessous.
```
/**
 * A convenience method, equivalent to 
 * {@link #getFoo()}.{@link Foo#getBar() getBar()}.{@link Bar#getBaz() getBaz()}.
 * @return baz
 */
public Baz fooBarBaz()
```
Étiquettes

Automatisé de refactoring ne peut pas affecter des étiquettes. Cela inclut le renommage de la méthode, de la classe ou de paquet; et la modification de la signature de la méthode.

Par conséquent, de fournir une étiquette seulement si vous voulez un texte différent de celui par défaut.

Par exemple, vous pouvez lier à partir d'un langage humain pour code:
```
/** You can also {@linkplain #getFoo() get the current foo}. */
void setFoo( Foo foo ) { ... }
```
Ou vous pourriez accéder à partir d'un exemple de code avec un texte différent de celui par défaut, comme indiqué ci-dessus sous "Une chaîne d'appels de méthode." Cependant, cela peut être fragile, tandis que les Api sont en constante évolution.

Type d'effacement et d' #membre

Si la signature de la méthode inclut le type paramétré, l'utilisation de l'effacement de ces types dans la javadoc @link. Par exemple:
```
int bar( Collection<Integer> receiver ) { ... }

/** See also {@link #bar(Collection)}. */
void foo() { ... }
```
- Attendez: je veux juste le nom de la méthode avec un lien, je ne veux pas que le nom de la classe ainsi.
- Ah, d'accord. Le premier exemple dans le lien ci-dessus illustre.
- +1 pour la fourniture d'une version 6 de Java lien que je n'était pas liée à partir de l'Oracle JavaDoc HowTo page. Je ne peux toujours pas obtenir le long avec l'oracle des liens... (fixe des liens vers la version 6 de Java dans ma réponse).
- Claszen: download.oracle.com/javase/6/docs, puis sur javadoc dans le diagramme, puis sélectionnez Javadoc Outil de Référence Page (Microsoft Windows), puis balises Javadoc.
- Ebermann Merci! Essaie d'utiliser le 'docs' page comme point d'entrée dans l'avenir.
- Merci pour votre tentative d'ajouter la note importante au sujet des génériques. Je l'ai aimé, mais n'a pas obtenu à l'examen avant les autres. J'ai ajouté la section #membre et les génériques pour la réponse ci-dessus.
- Le label garde le lien court, en se cachant des colis et des informations de classe. C'est génial!
- L'étiquette est nuisible, si refactoring peut se produire -- et le refactoring est très facile de nos jours, pour le code pas partagées avec des tiers.
InformationsquelleAutor Andy Thomas

vous pouvez utiliser @see à faire:

exemple:

interface View {
        /**
         * @return true: have read contact and call log permissions, else otherwise
         * @see #requestReadContactAndCallLogPermissions()
         */
        boolean haveReadContactAndCallLogPermissions();

        /**
         * if not have permissions, request to user for allow
         * @see #haveReadContactAndCallLogPermissions()
         */
        void requestReadContactAndCallLogPermissions();
    }

OP: "Comment puis-je utiliser le @balise de lien de lien à une méthode?" Le @link balise peut être utilisé en ligne dans un paragraphe, comme demandé par l'OP. Le @voir balise ne peut pas. Voir plus de détails sur cette question.

InformationsquelleAutor vuhung3990

Vous devez vous connecter pour publier un commentaire.

Exemples

Étiquettes

Type d'effacement et d' #membre