[Java-gnome-developer] Enforcing documentation quality
Brought to you by:
afcowie
From: Nick K. <sy...@gm...> - 2011-01-19 01:52:55
|
We have been working on a project called the JavadocMiner<http://www.rene-witte.net/automatic-quality-assessment-source-code-comments-javadocminer-nldb2010>that evaluates the quality of Javadoc comments. Included in our list of metrics are the readability measures (Flesch, Fog and Kincaid). This is not the typical Javadoc syntactic analysis tool provided by Oracle using the docCheckDoclet, or the similar tool provided by checkstyle. We analyze the internal quality of the Javadoc comment itself, as well as the syntactic quality such as sync etc.. If you would like to use the tool to analyze the different applications of your project we would be happy to open source it for you. Cheers, Ninus. |