如何创建带有java.util链接的文档（原始文档）

Question

我有一个java文件。我想用java文档中的方法等。 如果我的一些方法使用java类或接口，例如： Collection<MyClass> names = new ArrayList<>();我该如何链接原始java.util文档的Collection或ArrayList？

例如：如果我生成以下代码到Javadoc，它存在于HTML doc中，但未链接到java.util的ArrayList。

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

感谢您的帮助。

Answer 1

您需要通过-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>.