Java – Are There Any Tools For Updating Javadoc Automatically

javajavadoc

I work on a code base that is … messy. One aspect of this messiness is that we have a ton of methods whose signatures no longer match the associated Javadoc. For instance:

/**
 *
 * @ param foo
 */
public void doFoo(int bar) {...

I'm no fan of generated Javadoc (as it's almost always worthless), but I really could use a tool that would go through our code, find cases like that, and:

remove the javadoc for the "foo" param
add javadoc for the "bar" param (but just a blank one, no auto-generated doc or anything)

Does such a tool exist? If not, does a tool that just does #1 exist? Even that much would significantly reduce the amount of garbage warnings we get in our builds. Thanks.

Best Answer

NetBeans has a tool for that. It does exactly what you ask.

You can either click on the Tools Menu, then Analyze Javadocs from the top, or right click on a file and click Tools, then Analyze Javadocs.

This then give you a list of all problems it finds with your Javadocs with an option to fix it. It allows you to fix a single problem in a method, fix the javadocs for the method, for the file, for the package, or for the entire project.

Related Solutions

Java – destructor for Java

Because Java is a garbage collected language you cannot predict when (or even if) an object will be destroyed. Hence there is no direct equivalent of a destructor.

There is an inherited method called finalize, but this is called entirely at the discretion of the garbage collector. So for classes that need to explicitly tidy up, the convention is to define a close method and use finalize only for sanity checking (i.e. if close has not been called do it now and log an error).

There was a question that spawned in-depth discussion of finalize recently, so that should provide more depth if required...

Java ResultSet how to check if there are any results

Assuming you are working with a newly returned ResultSet whose cursor is pointing before the first row, an easier way to check this is to just call isBeforeFirst(). This avoids having to back-track if the data is to be read.

As explained in the documentation, this returns false if the cursor is not before the first record or if there are no rows in the ResultSet.

if (!resultSet.isBeforeFirst() ) {    
    System.out.println("No data"); 
}

Best Answer

Related Solutions

Java – destructor for Java

Java ResultSet how to check if there are any results

Related Topic