Javadoc Link zu Verfahren in anderer Klasse

Question

Derzeit ist ich Referenzierung Methoden in anderen Klassen mit dieser Javadoc Syntax:

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

Und in dem, was ich aus der Dokumentation verstehe dies der richtige Weg ist, dies zu tun. Aber jetzt zum lustigen Teil oder frustrierend. Wenn ich diese javadoc erzeugen bekomme ich vor allem Fehler folgende:

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

Der erzeugte HTML-Code dafür ist:

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

Und natürlich habe ich keine Verbindung. Kann mir jemand sagen, was passiert, und irgendwelche Hinweise, wie das zu beheben ist?

Gemäß der ASCII-Tabelle stehen die Zeichen 123 und 64 für wold für {und @, also warum sind diese Zeichen nicht gültig, wenn diese Syntax gemäß der Dokumentation korrekt ist?

Answer 1

Für das Javadoc-Tag @see müssen Sie @link nicht verwenden; Javadoc erstellt einen Link für Sie. Versuchen

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

Here's more info about @see.

Answer 2

Abgesehen von @see, eine allgemeinere Art und Weise in einer anderen Klasse von beziehen und möglicherweise Methode dieser Klasse ist {@link somepackage.SomeClass#someMethod(paramTypes)}. Dies hat den Vorteil, dass es in der Mitte einer Javadoc-Beschreibung verwendet werden kann.

Von der 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

So ist die Lösung für das ursprüngliche Problem ist, dass Sie nicht brauchen, sowohl die „@see“ und die „{...} @link“ Verweise auf demselben Linie. Das "@link" -Tag ist autark und kann, wie bereits erwähnt, überall im Javadoc-Block eingefügt werden. So können Sie die beiden Ansätze mischen: