Wie schreibe ich Javadoc Links?

Question

Wie schreibe ich Links in Javadocs?

Derzeit habe ich so etwas wie:

{@link java.lang.Math#sqrt(double) Math.sqrt} 

den Text zu produzieren Math.sqrt, die dem java.lang.Math.sqrt(double) API verknüpfen sollten jedoch alle es tut, ist, den Text zu produzieren, keine Verbindung.

Answer 1

Um einen Link zu etwas Äußerliches, um Ihren Code zu bekommen, können Sie die -linkoffline Option

wo die -linkoffline Option hat das Format so etwas wie diese (künstlich eingewickelt) verwenden müssen:

-linkoffline http://java.sun.com/javase/6/docs/api/ 
      http://java.sun.com/javase/6/docs/api/ 

Dies teilt die JavaDoc-Tool, wo Sie den Link zum JavaDoc finden und für welche Pakete dieser Link verwendet werden soll. Vom 2. URL, wird es „Paket-Liste“ hängen Sie die tatsächliche URL zu laden:

http://java.sun.com/javase/6/docs/api/package-list

, die Sie durch das Laden in einem Browser überprüfen können, hat die Liste der Pakete in dieser JavaDoc URL dokumentiert enthalten. Dies teilt dem JavaDoc-Tool mit, dass alle @link Verweise auf irgendetwas in einem dieser Pakete mit der angegebenen URL verlinken sollen.

Answer 2

This document kann hilfreich sein, denken Sie daran, dass Sie für @link die URL für das Dokument verwenden müssen, zu dem Sie verlinken.

Answer 3

Meine Antwort ist sehr viel von Eddie zur Verfügung gestellt, aber sein genauer Code ist für mich nicht (oder zumindest, wenn die Version von javadoc verwenden, die mit Java kommt 1.6)

Wenn ich tue:

 javadoc -linkoffline http://java.sun.com/javase/6/docs/api/ 
          http://java.sun.com/javase/6/docs/api/package-list 
      -public FileName.java

dann javadoc klagt:

 javadoc: warning - Error fetching URL: 
    http://java.sun.com/javase/6/docs/api/package-list/package-list

Wenn auf der anderen Seite, Ich tue:

 javadoc -linkoffline http://java.sun.com/javase/6/docs/api/ 
          http://java.sun.com/javase/6/docs/api/ 
      -public FileName.java

Dann funktioniert es, und meine Links bestückt sind, wie ich sie sein wollen.

Außerdem ist mein Link nicht missgebildet. Der Text {@link java.lang.Math#sqrt(double) Math.sqrt} erzeugt den Verknüpfungstext Math.sqrt anstelle des Standards Math.sqrt(double).