2016-12-21 2 views
1

Ich habe einen Javadoc-Kommentar wie folgt definiert Klicken auf die zugegriffen werden soll:Wie Javadoc Links zu definieren, kann man erkennen, durch

/** 
* bla bla bla {@link #PathAction} bla bla bla... 
* 
* @author andreas 
* 
* @param <T> 
*/ 

wenn auf dem Objekt CustomPath im Java-Code Bewegen der Maus ich folgendes sehen:

enter image description here

Wenn auf den PathAction Links in der Beschreibung klicken, geschieht nichts. Ich habe erwartet, dass ich zum PathAction-Objekt weitergeleitet wurde.

Ist dieses Verhalten standardmäßig oder ich mache etwas falsch. Gibt es eine Möglichkeit, dass ich auf das PathAction-Objekt umgeleitet werden kann oder wie kann ich auf das Javadoc von PathAction zugreifen? Mein Ziel ist es, den Code mit Javadoc-Kommentaren zu lesen.

irgendwelche Vorschläge?

+1

Versuchen vollständigen Namen verwenden, so etwas wie: @link # com.stackoverflow.packagename.PathAction –

+0

@FilipMalczak außer ohne die '#', wie das ist, um Methoden und Felder zu verknüpfen –

+0

Wahr, mein schlechtes. Habe es nicht getestet und online überprüft, deshalb ist es ein Kommentar, anstatt der Antwort. –

Antwort

4

das Hash-Symbol vor dem Namen der Klasse entfernen. Dies wird normalerweise beim Verknüpfen mit Methoden verwendet. Auch wäre es besser, den vollständig qualifizierten Klassennamen zu verwenden:

/** 
* bla bla bla {@link full.name.of.PathAction} bla bla bla... 
* 
* @author andreas 
* 
* @param <T> 
*/ 

Relevante Dokumentation: http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDDIECH:

{@link package.class # member label}

+0

Nun, wenn die Klasse im * selben * Paket ist; dann ist der Paketname möglicherweise nicht erforderlich. – GhostCat

+0

Perfekt vielen Dank! Annahme in 7 Minuten. –

Verwandte Themen