我正在寻找可以指出不正确的JavaDoc注释的工具(或IDE功能)。也就是说,具有缺少参数的注释,具有错误的参数名称,不记录抛出的异常等等。
我知道没有一个完美的工具,因为工具无法告诉我们文档是否正确,但我希望识别更明显的错误至少可以帮助捕获一些不正确的JavaDoc注释
最好这个工具可以忽略简单的getter和setter(例如,我通常不会在getter中包含@returns
,因为它们的摘要会详细说明您需要知道的所有内容。)
答案 0 :(得分:3)
使用Eclipse可以标记丢失或错误的JavaDoc。 查看Window-> Preferences-> Java-> Compiler-> JavaDoc。激活Process JavaDoc注释并选择所需选项。