METRICS.PJDC

Percentage of Javadoc comments(%)

This metric measures the percentage of Javadoc comments in a class or interface.

This metric is measured using the following formula:

% javadoc = #Javadoc in a file / (#fields + #methods + 1) * 100

Note: 1 is for either the class or interface's Javadoc comments.

Every class, interface, method, and field should have a Javadoc comment associated with it.

By default, Jtest reports an error if this metric's value is not between 60% and 100%.

Mark Schroeder. "A Practical Guide to Object-Oriented Metrics." IT Pro, November/December, 1999.