教你如何在 javadoc 输出<> 符号

当我们在撰写Java API文档时，有些类和方法的描述中可能涉及到尖括号（<和>）等特殊符号，但是当这些符号在javadoc中直接显示时会被解析为html标签，导致javadoc的显示不正常，影响使用。那么，如何在javadoc中输出这些特殊符号呢？下面是详细攻略：

1. 使用html实体字符

可以使用html实体字符来替代尖括号，其中大于号可用>代替，小于号可用<代替。示例如下：

/**
* 一个包含泛型参数的方法
* @param <T> 泛型类型参数
*/
public <T> void test (T t) {
  // Method implementation here
}

上述代码中，我们使用了html实体字符替代了泛型参数的尖括号，在javadoc中显示正常。

2. 使用{@literal}标签

java文档注释提供了{@literal}标签，可以用于不需要解析的字符或字符串。示例如下：

/**
* 一个包含尖括号的字符串方法
* @param s 字符串参数
* @return {@literal <}prefix{@literal >}suffix{@literal /<}
*/
public String test (String s) {
  return "{@literal <}prefix{@literal >}suffix{@literal /<}";
}

上述代码中，我们使用了{@literal}标签将字符串中的尖括号替换掉了，从而在javadoc中显示了源码中的尖括号。

综上所述，我们可以通过html实体字符或{@literal}标签来输出尖括号等特殊符号，使得javadoc的显示正常。