2016-07-28 25 views
2

Ich habe eine Java-Datei. Und ich möchte mit Java-Dokumentation für Methoden und etc. verwenden. Wenn meine Methode mit Java-Klassen oder Schnittstellen, zum Beispiel: Collection<MyClass> names = new ArrayList<>(); Wie kann ich die Sammlung oder ArrayList der ursprünglichen java.util Dokumentation?Wie kann ich Dokumentation mit Links von java.util (Originaldokumentation) erstellen

zum Beispiel: Wenn ich den folgenden Code zu Javadoc erzeuge, ist es in HTML doc vorhanden, aber nicht mit ArrayList von java.util verknüpft.

/** 
* The constructor using with {@link Collection} - interface and {@link ArrayList} - class for initialize.... 
* 
*/ 
public myConstructor(){ 
    names = new ArrayList<>(); 
    ........ 
} 

Danke für Hilfe.

+0

Sie haben alle Warnungen, wenn javadoc zu erzeugen? –

+0

Keine Warnungen, aber wenn Dokument ausgeführt wird, sind die Wörter ArrayList oder Collection nicht verknüpft, sie sind Textdaten – morris

Antwort

4

Sie müssen die zusätzliche externe Dokumentation über die Befehlszeilenoption -link an das Tool javadoc übergeben, z. -link https://docs.oracle.com/javase/8/docs/api/.

Die Links sollten dann eingefügt werden, sofern die Klassen importiert oder vollständig qualifiziert sind.

Beispiel:

import java.util.Collection; 

/** 
* {@link java.util.ArrayList} is a {@link Collection}. 
*/ 
public class MyClass { 
} 
javadoc -link https://docs.oracle.com/javase/8/docs/api/ MyClass.java 

Relevante Teil des Ergebnisses:

<a href="https://docs.oracle.com/javase/8/docs/api/java/util/ArrayList.html?is-external=true" title="class or interface in java.util"><code>ArrayList</code></a> is a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><code>Collection</code></a>.

+0

Kannst du mir ein Beispiel zeigen? Vielen Dank. – morris

+1

@morris hat ein Beispiel hinzugefügt – fabian

+0

Vielen Dank, es funktioniert !!) – morris