• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Aaak! Javadoc comments!

 
Robert Konigsberg
Ranch Hand
Posts: 172
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,

Looks like javadoc likes adding implied constructors to the documentation. Does this mean I need to supply default constructors, just so I can add javadoc comments?!

Did people pass the exam without these?

Thanks, Rob
 
Javini Javono
Ranch Hand
Posts: 286
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,

I'm not a JavaDoc specialist, but if what you assert is true,
then I'd say that you would want to declare the default
constructor and based upon docCheck, you can have a
simple one-liner to document it.

Another factor that comes into play is how much JavaDoc
you are doing. I'm using the -public flag. If you are using
JavaDoc at the package private level, then perhaps this is why
you are getting JavaDoc non-comments for constructors to
classes which are not public.

All in all, I attempt to not have anything show up in the JavaDoc
which is not documented by me. And, using the -public flag
may not be the norm, but it is what I decided to use.

Thanks,
Javini Javono
[ July 02, 2004: Message edited by: Javini Javono ]
 
It is sorta covered in the JavaRanch Style Guide.
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic