Is there a way to validate the presence of Javadoc and/or inline code comments?

Posted by Chris Aldrich on Stack Overflow See other posts from Stack Overflow or by Chris Aldrich
Published on 2010-04-05T18:28:53Z Indexed on 2010/04/05 18:33 UTC
Read the original article Hit count: 245

Filed under:

javadoc

|

plug-ins

|

subclipse

|

subversion

|

code-review

We are trying to put quality code processes in place for a large project I am working on. Right now a lot of developers are not putting in Javadoc or in-line code comments into their code. Ok right now. But it will severely hurt us in the very near future. We are using Maven 2.0.9 as our build tool, as well as Hudson for Continuous Integration. We are using Subversion as our source versioning tool/code repository, Rational Application Developer and Rational Softare Architect (essentially Eclipse) 7.5.1 as our IDE's, and then Subclipse as our Eclipse plug-in to connect to SVN.

Is there a plug-in or a way to validate that a developer put in Javadoc and/or in-line code comments in order to allow a commit to SVN? This isn't intended to be a substitute for good code reviews, but merely a help to make sure that developers are reminded to add this documentation before committing. We are still intending on conducting code reviews that would also review documentation.

Has anyone found any plug-ins for something like this? Any links? Any ideas?

© Stack Overflow or respective owner

Related posts about javadoc

Create javadoc with multiple src dirs

as seen on Stack Overflow - Search for 'Stack Overflow'
I have a Util package with source files in three seperate directories, defined like so: src/com/domain/util src/Standard/com/domain/util src/Extended/com/domain/util The package is built with the first set of files and either one of the second or third set, to create a total of two different implementations… >>> More
javadoc and overloaded methods

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi all, I'm developing an API with many identically named methods that just differ by signature, which I guess is fairly common. They all do the same thing, except that they initialize various values by defaults if the user does not want to specify. As a digestible example, consider public interface… >>> More
Javadoc through Ant task with {@inheritDoc} from J2SE classes

as seen on Stack Overflow - Search for 'Stack Overflow'
I generate documentation for a project using an Ant task. In several places, I wanted to inherit documentation from the standard classes, so I used {@inheritDoc} which allowed me to see the Javadoc in Eclipse, but it wouldn't show up in the HTML files. The problem was that I hadn't included the unzipped… >>> More
how generate javaDoc from a jaxb file

as seen on Stack Overflow - Search for 'Stack Overflow'
hi, i am working with Jaxb. and i would like to generate javaDoc files from these classes, is it the same way as i would do it to a regular java files? >>> More
Getting javadoc for Google Wave robot programming in Eclipse

as seen on Stack Overflow - Search for 'Stack Overflow'
Hey, Does anyone know how I can get the helpful Eclipse popups with javadoc when programming for the Google Wave Robots API? I have access to the JAR-file, the HTML Javadoc, as well as the source files from here How do I set up eclipse so I get javadoc integrated? I have tried adding the source… >>> More

Related posts about plug-ins

5 Useful Wordpress Plugins For Google Adsense

as seen on Just Skins - Search for 'Just Skins'
Google Adsense has become the most popular online contextual advertising program and proper custom integration with Wordpress can help to increase Adsense earnings. Now on this post we have describe 5 useful wordpress plugin for google adsense. Few weeks ago we did a "10 Wordpress Plugins For… >>> More
Maven Plugin - are plugins executable within plugins?

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi all, Is it possible to execute a plugin from a plugin? For instance, if I want to programmatically call another plugin from within a plugin, not via static XML. Is this possible, how would I do that? Thanks, Walter >>> More
Error deploying Spring application to Jboss due to ClassCastException

as seen on Server Fault - Search for 'Server Fault'
When I try to deploy a spring application in Jboss, I get this error: 11:32:34,045 ERROR [AbstractKernelController] Error installing to Start: name=persistence.unit:unitName=#ehr-punit state=Create java.lang.RuntimeException: Specification violation [EJB3 JPA 6.2.1.2] - You have not defined a jta-data-source… >>> More
Migration and deployement problems JBoss 4.2.2.GA to JBoss 6.0.0.M2

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi, I'm trying to migrate an application running on JBoss 4.2.2.GA to JBoss 6.0.0.M2 I give you some log to explain my problem : boot.log : 2010-03-16 09:59:29,406 ERROR [org.jboss.system.server.profileservice.ProfileServiceBootstrap] (Thread-2) Failed to load profile: Summary of incomplete deployments… >>> More
Error starting jboss server

as seen on Stack Overflow - Search for 'Stack Overflow'
I've just finished re-installing my OS, and as always install and test standard tools which I use, and now I get this error like never before when I tried to start Jboss 5 from eclipse, its quite big exeption : 3:53:10,693 ERROR [AbstractKernelController] Error installing to Instantiated: name=AttachmentStore… >>> More