Javadoc link per il metodo in altra classe

Question

metodi Attualmente sto fanno riferimento in altre classi con questa sintassi Javadoc:

@see {@link com.my.package.Class#method()} 

E in quello che ho capito dalla documentazione questo è il modo corretto per farlo. Ma ora per la parte divertente, o frustrante. Quando ho generano questo javadoc ho prima di tutto ottenere seguente errore:

warning - Tag @see:illegal character: "123" in "{@link com.my.package.Class#method()}" 
warning - Tag @see:illegal character: "64" in "{@link com.my.package.Class#method()}" 
warning - Tag @see: reference not found: {@link com.my.package.Class#method()} 

il codice HTML generato questo è:

"," <code>com.my.package.Class#method()}</code> "," 

E naturalmente non ho alcun legame. Qualcuno può dirmi cosa sta succedendo e qualche suggerimento su come risolvere questo problema?

Secondo i caratteri di tabella ASCII 123 e 64 per wold rappresentano {e @, quindi perché questi caratteri non sono validi quando questa sintassi è corretta secondo la documentazione?

Answer 1

Per il tag Javadoc @see, non è necessario utilizzare @link; Javadoc creerà un collegamento per te. Prova

@see com.my.package.Class#method() 

Here's more info about @see.

Answer 2

parte @see, un modo più generale riferendosi ad un altro metodo di classe e, eventualmente, di quella classe è {@link somepackage.SomeClass#someMethod(paramTypes)}. Questo ha il vantaggio di essere utilizzabile nel mezzo di una descrizione javadoc.

Dal javadoc documentation (description of the @link tag):

This tag is very simliar to @see – both require the same references and accept exactly the same syntax for package.class#member and label. The main difference is that {@link} generates an in-line link rather than placing the link in the "See Also" section. Also, the {@link} tag begins and ends with curly braces to separate it from the rest of the in-line text.

Answer 3

Quindi la soluzione al problema originale è che non hai bisogno di entrambe le "@see" e le "{@link ...}" referenze sullo stesso linea. Il tag "@link" è autosufficiente e, come noto, puoi metterlo ovunque nel blocco javadoc. Quindi puoi unire i due approcci:

/** 
* some javadoc stuff 
* {@link com.my.package.Class#method()} 
* more stuff 
* @see com.my.package.AnotherClass 
*/