我正在寻找可以指出不正确的JavaDoc注释的工具(或IDE功能).也就是说,具有缺少参数的注释,具有错误的参数名称,不记录抛出的异常等.
我知道没有一个完美的工具,因为工具无法告诉我们文档是否正确,但我希望识别更明显的错误至少可以帮助捕获一些不正确的JavaDoc注释.
最好这个工具可以忽略简单的getter和setter(例如,我通常不会在getter中包含@returns,因为它们的摘要详细说明了你需要知道的一切).
解决方法:
使用Eclipse,可以标记丢失或错误的JavaDoc.
查看Window-> Preferences-> Java-> Compiler-> JavaDoc.激活Process JavaDoc注释并选择所需选项.
版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 [email protected] 举报，一经查实，本站将立刻删除。
