我正在寻找可以指出不正确的 JavaDoc 注释的工具(或 IDE 功能)。也就是说,缺少参数、参数名称错误、不记录抛出的异常等的注释。
我知道不会有完美的工具,因为工具无法告诉我们文档是否正确,但我希望识别更明显的错误至少可以帮助捕获一些不正确的 JavaDoc 注释.
这个工具最好有忽略简单的 getter 和 setter 的方法(例如,我通常不在 getter 上包含 @returns
,因为它们的摘要详细说明了您需要知道的一切).
最佳答案
使用 Eclipse 可以标记丢失或错误的 JavaDoc。 查看Window->Preferences->Java->Compiler->JavaDoc。激活处理 JavaDoc 注释并选择所需的选项。
关于java - 是否有用于识别过时/不一致的 JavaDoc 注释的工具?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/24023668/