Java 代码注释中超链接的使用

1. 使用 @see

必须作为独占一行的注释使用，类似于 @author 的使用方式，可以链接到 Java 的类、方法和字段，还可以链接到外部链接（使用标准的 html 标记 a），格式为：

@see className
@see fully-qualified-className
@see fully-qualified-className#fieldName
@see fully-qualified-className#methodName
@see fully-qualified-className#methodName(argumentType)
@see <a href="the-url">the-label</a>
@see link1 link2 ...

类名和方法、字段名之间用 # 号连接在一起。

例子：

/**
 * @see TestUtils
 * @see tech.simter.start.r2dbc.TestUtils
 * @see tech.simter.start.r2dbc.TestUtils#id
 * @see Object#clone()
 * @see tech.simter.start.r2dbc.TestUtils#equals(Object)
 * @see <a href="https://google.com">google.com</a> <a href="https://bing.com">bing.com</a>
 */

效果：（生成 See Also: link1, link2, ...）

See Also: TestUtils, tech.simter.start.r2dbc.TestUtils, Object#clone(), tech.simter.start.r2dbc.TestUtils#equals(Object), google.com, bing.com

2. 使用 @link 或 @linkplain

只可以链接到 Java 的类、方法、字段，不可以链接到外部链接，内联到注释文本内，格式为 {@link 实际地址 显示的文本}，实际地址 的值与上述 @see 中的类、字段、方法的格式相同，如果省略 显示的文本，则默认显示 实际地址。

例子：

/**
 * 参考 {@link Object#clone() 对象克隆方法} 和 {@link Object#equals(Object) }
 */

效果：

参考 对象克隆方法 和 Object.equals(Object)

3. 直接使用标准 html 标记 a

创建外部链接的唯一方法，上述的 @see 外部链接也是使用这种方式。

例子：

/**
 * 参考 <a href="https://google.com">google.com</a>。
 */

效果：

参考 google.com。