Is there a tool to identify obsolete / inconsistent JavaDoc comments?

I am looking for a tool (or an IDE function) that can indicate invalid JavaDoc comments. That is, comments that have no arguments have an incorrect name for the arguments, do not document abandoned exceptions, etc.

I know that there would be no ideal tool, since the tool cannot tell us the correct documentation, but I hope that identifying more obvious errors can at least help to catch some incorrect JavaDoc comments.

It is preferable that this tool be able to ignore simple getters and setters (for example, I often do not include @returnsgetters, because their final data is all you need to know).

+4
source share
1 answer

With Eclipse, a missing or incorrect JavaDoc can be noted. Look at Window-> Preferences-> Java-> Compiler-> JavaDoc. Activate Process JavaDoc comments and select the options you want.

+3
source

Source: https://habr.com/ru/post/1543121/


All Articles