Link Javadoc metody w innej klasy

Question

Obecnie jestem odwoływania się metody w innych klasach z tej składni Javadoc:

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

A co rozumiem z dokumentacji to jest poprawny sposób to zrobić. Ale teraz do zabawnej części lub frustrującej. Kiedy wygenerowania tego javadoc I przede wszystkim uzyskać następujący błąd:

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()} 

wygenerowany kod HTML jest:

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

I oczywiście nie mam linku. Czy ktoś może mi powiedzieć, co się dzieje, i wszelkie wskazówki, jak to naprawić?

Zgodnie z tabelą znaków ASCII 123 i 64 dla wold reprezentują {i @, więc dlaczego te znaki nie są poprawne, jeśli składnia jest poprawna zgodnie z dokumentacją?

Answer 1

Dla znacznika Javadoc @see nie trzeba używać @link; Javadoc utworzy dla ciebie link. Spróbuj

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

Here's more info about @see.

Answer 2

Oprócz @see, bardziej ogólny sposób nawiązujące do innej klasy i ewentualnie metoda tej klasy jest {@link somepackage.SomeClass#someMethod(paramTypes)}. Ma to tę zaletę, że można go użyć w środku opisu javadoc.

Z 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

Więc rozwiązanie pierwotnego problemu jest to, że nie trzeba zarówno „@see” i „{...}” @link odniesienia na tej samej linia. Znacznik "@link" jest samowystarczalny i, jak wspomniano, można umieścić go w dowolnym miejscu w bloku javadoc. Możesz więc połączyć oba podejścia:

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