2016-07-28 65 views
2

我有一個java文件。我想用java文檔中的方法等。 如果我的一些方法使用java類或接口,例如: Collection<MyClass> names = new ArrayList<>();我該如何鏈接原始java.util文檔的Collection或ArrayList?如何創建帶有java.util鏈接的文檔(原始文檔)

例如:如果我生成以下代碼到Javadoc,它存在於HTML doc中,但未鏈接到java.util的ArrayList。

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

感謝您的幫助。

+0

生成javadoc的時候你有什麼警告? –

+0

沒有警告,但是當文檔執行時,單詞ArrayList或Collection不是鏈接的,它們是文本數據 – morris

回答

4

您需要通過-link命令行選項將其他外部文檔傳遞給javadoc工具,例如, -link https://docs.oracle.com/javase/8/docs/api/

然後插入鏈接,只要這些類是導入的或完全合格的。

例子:

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 

結果的相關部分:

<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

你能告訴我一個例子嗎?謝謝。 – morris

+1

@morris增加了一個例子 – fabian

+0

謝謝,它的工作! ) – morris