I often do mistakes when write my JavaDoc comments. Do you know a tool to avoid

JavaFAQ Home » General Java

Question: I often do mistakes when write my JavaDoc comments. Do you know a tool to avoid it?

Answer: Yes, I know, at least one: iDoc - the javadoc documentation QA tool.
On iDoc's web site:

iDoc warns about missing and obsolete @param and @return tags in method comments. This enables you to keep documentation and code in synch.

iDoc finds typos in tag names (e.g. if you typed @versuon instead of @version). This guards against missing documentation entries due to typos.

iDoc finds comments that do not have a descriptive "title". In addition this also points out classes, interfaces, methods and instance variables that do not have a javadoc code comment at all.

iDoc is a "smart grep" utility that can search for specific comment entries in your source code (e.g. list all methods that contain a "@open ..." tag in their comment). This enables you to introduce your own tags, such as "@open", "@rework", etc.

iDoc lists all occurrences of tags that are not part of the standard javadoc tag set (@author, @version, @param, etc.).

It is free!
--
John

Custom Search