Javadoc 具有不可能的“throws”标记¶
ID: java/inconsistent-javadoc-throws
Kind: problem
Security severity:
Severity: recommendation
Precision: high
Tags:
- maintainability
Query suites:
- java-security-and-quality.qls
Javadoc @throws 或 @exception 标记引用无法抛出的异常，这是误导性的。
建议¶
确保仅在可以抛出异常时在 Javadoc 中包含 @throws 或 @exception 标记。
示例¶
以下示例显示了一个 Javadoc 方法，该方法声称可以抛出 Exception。由于 Exception 是一个已检查的异常，并且该方法没有声明它可能会抛出一个异常，因此 Javadoc 是错误的，应该更新。
/**
* Javadoc for method.
*
* @throws Exception if a problem occurs.
*/
public void noThrow() {
System.out.println("This method does not throw.");
}
在以下示例中，Javadoc 已通过移除 @throws 标记得到更正。
/**
* Javadoc for method.
*/
public void noThrow() {
System.out.println("This method does not throw.");
}
参考¶
Java SE 文档：如何为 Javadoc 工具编写文档注释，