在Javadoc中链接到外部URL

一、简介

在编写代码时，我们可能会参考互联网上的文章，例如维基页面、指南或图书馆的官方文档。 在 Javadoc 中添加此类参考文章的链接可能是个好主意。

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

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

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

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

让我们考虑一个例子：

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

这将呈现为：

参考拜尔东

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

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

考虑以下示例：

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

这将创建一个包含链接的“另请参阅”标题：
也可以看看：
拜尔东

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

{@关联 }

假设我们有一个包含方法 demo 的类 DemoOne ：

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

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

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

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

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

总而言之，当我们在描述中使用类或方法名称时， @link 是首选。另一方面，当描述中未提及相关引用或作为同一引用的多个链接的替代时，使用 @see 。

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