Hi Dave,
- Ensure that all parameters, return, and throws statements have associated JavaDoc
I just generated the javadoc and clicked my way through all files to see that they all have non-empty descriptions. Javadoc will issue warnings when the Javadoc for a member does not match the declaration, but won't inform you of Javadoc missing altogether.
- Ensure that there all variables, methods and classes are actually utilised.
I used JBuilder to edit the code, which marks private members that are not used (statically). You can download a free version at
the borland web site, but you will still will have to scan through all your source files.
IIRC Eclipse has a similar capability.
You can also use the
Emma coverage
testing package to check that all your code is actually (dynamically) used. Sadly, I never managed to get it to run in combination with RMI. (But it must have been me, because others have reported here that they could.)
Frans.
[ February 18, 2005: Message edited by: Frans Janssen ]