web-dev-qa-db-fra.com

Liaison Javadoc à une classe dans un autre package

J'ai deux packages, Shapes et Fruits:

com.myproject.Shapes.
    Circle
    Square
    Triangle
com.myproject.Fruits.
    Apple
    Orange

J'écris le JavaDoc pour Apple et je dois fournir un {@link} à Square.

J'ai essayé toutes les solutions suivantes, et aucune d'entre elles ne fonctionne:

{@link Square}
{@link com.myproject.Square}

J'ai pu trouver de la documentation pour établir un lien vers: (a) des classes dans le même package, ou (b) des URL externes, mais pas des classes dans un autre package.

Des idées sur la syntaxe correcte? Merci!

javajavadoc
58
IAmYourFaja

Les variantes syntaxe correcte sont

{@link [<package>.]<class>[#<method>]}
{@link #<method>}

Il vous manquait un package complet. L'exemple suivant doit être correct

{@link com.myproject.Shapes.Square} 
                     ^^^^^^
78
Johan Sjöberg

Pour un autre package, utilisez cette syntaxe:

{@link  package.class#member  label}

Dans votre cas, cela devrait être:

{@link com.myproject.Shapes.Square Square}

Si vous souhaitez afficher uniquement le nom de la classe, utilisez l'étiquette, si le chemin complet est souhaité, alors l'étiquette n'est pas requise.

Référence: http://docs.Oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#link

17
Pranav Shah