1. Introduction

1.绪论

While writing our code, we might refer to articles on the internet like wiki pages, guides, or official documentation of a library. It could be a good idea to add the links to such reference articles in the Javadoc.

在编写代码时，我们可能会参考互联网上的文章，如wiki页面、指南或某个库的官方文档。在Javadoc中添加这些参考文章的链接可能是一个好主意。

In this tutorial, we’ll learn how to reference an external URL in Javadoc.

在本教程中，我们将学习如何在Javadoc中引用一个外部URL。

2. Creating an In-Line Link

2.创建一个在线链接

Java does not offer any special tools for external links, but we can just use standard HTML. The following syntax is used to create an in-line link:

Java没有为外部链接提供任何特殊的工具，但我们可以直接使用标准的HTML。下面的语法用于创建一个行内链接。

/**
 * Some text <a href="URL#value">label</a> 
 */

Here, the URL#value can be a relative or absolute URL.

这里，URL#value可以是一个相对或绝对的URL。

Let’s consider an example:

让我们考虑一个例子。

/** 
 * Refer to <a href="http://www.baeldung.com">Baeldung</a> 
 */

This will render as:

这将呈现为。

Refer to Baeldung

参考信息。

3. Creating an In-line Link With a Heading

3.创建带有标题的行内链接

Another way is to create a heading containing the link. The @see tag is used as follows to achieve this:

另一种方法是创建一个包含链接的标题。 @see标签的使用方法如下。

/**
 * @see <a href="URL#value">label</a>
 */

Consider the following example:

请考虑以下例子。

/**
 * @see <a href="http://www.baeldung.com">Baeldung</a> 
 */

This will create a ‘See Also’ heading containing the link:
See Also:
Baeldung

这将创建一个包含链接的 “另见 “标题：
另见：
Baeldung。

4. Creating a Link to Javadoc of Another Class

4.创建一个指向另一个类的Javadoc的链接

The @link tag is specifically used to link to the Javadoc of other classes and methods. This is an inline tag that converts to an HTML hyperlink pointing to the documentation of the given class or method reference:

@link标签专门用于链接到其他类和方法的Javadoc。这是一个内联标签，转换为一个HTML超链接，指向给定的类或方法引用的文档。

{@link <class or method reference>}

{@link <类或方法引用>}

Suppose we have a class DemoOne containing a method demo:

假设我们有一个类DemoOne，包含一个方法demo。

/** 
 * Javadoc
 */
class DemoOne {
  
  /**
   * Javadoc
  */
  void demo() {
    //some code
  }
}

Now, we can link to the Javadoc of the above class and method from another class, in the following ways:

现在，我们可以通过以下方式从另一个类链接到上述类和方法的Javadoc。

/** 
 * See also {@link org.demo.DemoOne}
 */

/**
 * See also {@link org.demo.DemoOne#demo()}
 */

This tag can be used anywhere that a comment can be written, while @see creates its own section.

这个标签可以用在任何可以写评论的地方，而@see则创建自己的部分。

To summarize, @link is preferred when we use a class or method name in the description. On the other hand, @see is used when a relevant reference is not mentioned in the description or as a replacement for multiple links to the same reference.

总结一下，当我们在描述中使用类或方法名时，@link是首选。另一方面，@see在描述中没有提到相关的参考文献时使用，或者作为同一参考文献的多个链接的替代。

5. Conclusion

5.总结

In this article, we learned about the ways to create an external link in Javadoc. We also looked at the difference between the @see and @link tags.

在这篇文章中，我们了解了在Javadoc中创建外部链接的方法。我们还研究了@see和@link标签之间的区别。