Win a copy of The Little Book of Impediments (e-book only) this week in the Agile and Other Processes forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Checking Javadoc

 
Gregory Till
Greenhorn
Posts: 7
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi all,

I'm getting ready to submit my project and I found 1 or 2 issues with the javadoc. I noticed that 1 of my methods was missing a @param tag for 1 of it's parameters, but javadoc didn't report this as a problem. Is there a flag for javadoc to show those discrepencies or any utilities that check for them? I'm going blind double checking all my code.

I'm using Standard Doclet version 1.5.0_01

Thanks,

Greg
 
Daniel Dalton
Ranch Hand
Posts: 146
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
You could try checkstyle
 
Gregory Till
Greenhorn
Posts: 7
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thanks Daniel,

My life got worse when Jalopy went commercial, but it looks like I'm on the up again!

Greg
 
Andrew Monkhouse
author and jackaroo
Marshal Commander
Pie
Posts: 12014
220
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Gregory and Daniel,
You could try checkstyle


Another posibility is the Doc Check Doclet.

Regards, Andrew
 
Gregory Till
Greenhorn
Posts: 7
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thanks, Andrew

I'll try Doc Check Doclet after I've fixed the 2675 warnings checkstyle came up with ;-)

No really...
 
Muthaiah Ramanathan
Ranch Hand
Posts: 102
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Yeah, check style really checks for EVERYTHING. So you can make choices in the .xml file. For eg, I commented out the option for 'LocalFinalVariableName'.

Once you are done, I would also suggest you to try the 'DocCheck'.
 
Gregory Till
Greenhorn
Posts: 7
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thanks for all the help folks.

I left all the scheckStyle default sun standards options turned on - BSTS. Surprising what improvements I've made to my code.

It might be worth mentioning that Doc Check Doclet pulled up a few things that checkStyle doesn't check for, so it's worth using both of them.

Should give me a bit more re-assurance when I submit.

Greg
 
Samuel Pessorrusso
Ranch Hand
Posts: 164
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I use checkstyle for a long time but there are some warnings that I really think is annoying.
Example:

Method parameters as final.
Interface must have some methods (But I like to use them to store constants, not just behavior)
Modifyiers are redundant in Interfaces (I think it�s easier to read when a specify the �public static final�)
A parameters hides an instance property.


Anyone agree with me? Do I need to make my code perfect to checkstyle or can I follow my improved Sun code style

[ August 18, 2005: Message edited by: Samuel Pessorrusso ]
[ August 18, 2005: Message edited by: Samuel Pessorrusso ]
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic