是否有用于识别过时/不一致的 JavaDoc 注释的工具？

Question

我正在寻找可以指出不正确的 JavaDoc cmets 的工具（或 IDE 功能）。也就是说，缺少参数、参数名称错误、不记录抛出的异常等的 cmets。

我知道不会有完美的工具，因为工具无法告诉我们文档是否正确，但我希望识别更明显的错误至少可以帮助捕获一些不正确的 JavaDoc cmets .

这个工具最好有忽略简单 getter 和 setter 的方法（例如，我通常不会在 getter 上包含 @returns，因为它们的摘要详细说明了您需要知道的所有内容）。

Answer 1

使用 Eclipse 可以标记缺失或错误的 JavaDoc。 查看 Window->Preferences->Java->Compiler->JavaDoc。激活 Process JavaDoc cmets 并选择所需的选项。