常用的注释标签包括:
@param | 注释方法参数 | @param paramName |
@return | 注释方法返回值 | @return |
@throws | 注释方法可能抛出的异常 | @throws NullPointerException |
@code | 添加代码注释说明,常和<pre>一起使用 | <pre>{@code index<0}</pre> |
@literal | 处理HTML特殊字符,使用此标签的注释不会被视为HTML文本被渲染。也可以使用数据实体如&替代特殊字符 | {@literal x<y} |
@inheritDoc | 声明直接使用继承的注释 | {@inheritDoc} |
HTML标签 | 如<p>, <i> |
常见的API元素包括:类,接口,方法(参数,返回值,抛出的异常),属性,枚举量,泛型参数(使用@param注释)
package的注释可以放在package-info.java里