JDocCoverage - JavaDoc and Comment Coverage

JDocCoverage is a Java tool to analyze the quality of the documentation of the Java source code. The quality management is very important on large projects with many developers. There are many steps to do this.

• First there there are unit tests. For example this can be do with the popular Java tool JUnit.
• Then you need a code coverage to check the test density of the unit tests. You can do this with the popular tool EMMA.
• Then you need a good documentation of the source code.

Every developer know that a documentation of the source code is required. But the most developer are lazy. If a project part is finish then the documentation is forget. This is the point where JDocCoverage is starting.

How does JDocCoverage work?

JDocCoverage can't check the context of the comments but it can:

• check the comment density. The percentage between source code and comments. A source code with 10% comments is good comments
• check if every method has a JavaDoc.
• check if all method parameters are documented and if the names are correct
• check for TODO tags
• skip comment out source code.
• skip auto generated comments from known IDE's
• skip the license preamble.

How look the result?

Here are some sample results.

• JDocCoverage
• SmallSQL Database

How to use it?

Currently you can only use it as command line tool. We will add more interfaces in future versions.

java -jar jdoccoverage.jar <options> <source files>

samples:

java -jar jdoccoverage.jar src/
java -jar jdoccoverage.jar src/**/*.java src2/?abc*.java"
java -jar jdoccoverage.jar -d output src/