73 votes

Javadoc Reliant à un Autre Package

J'ai deux paquets, Shapes et Fruits:

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

Je suis en train d'écrire la JavaDoc pour Apple et la nécessité d'offrir un {@link} de Square.

J'ai essayé toutes les suivantes, et aucune de ces travaux:

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

J'ai été en mesure de trouver de la documentation pour le lien: (a) les classes dans le même package, ou (b) des alias d'Url, mais pas de classes dans un autre package.

Les idées de ce que la syntaxe correcte devrait être? Merci!

96voto

Johan Sjöberg Points 20759

La syntaxe correcte variantes sont

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

Il vous manque un paquet complet. L'exemple suivant devrait être correct

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

20voto

Pranav Shah Points 1567

Pour un autre paquet, utilisez cette syntaxe:

{@link  package.class#member  label}

Dans votre cas, cela doit être:

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

Si vous souhaitez afficher uniquement le nom de la classe puis d'utiliser l'étiquette, si le chemin d'accès complet est souhaité, puis l'étiquette n'est pas nécessaire.

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

Prograide.com

Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.

Powered by:

X