This week's giveaway is in the Android forum.
We're giving away four copies of Android Security Essentials Live Lessons and have Godfrey Nolan on-line!
See this thread for details.
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes Aaak! Javadoc comments! Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login

Win a copy of Android Security Essentials Live Lessons this week in the Android forum!
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "Aaak! Javadoc comments!" Watch "Aaak! Javadoc comments!" New topic

Aaak! Javadoc comments!

Robert Konigsberg
Ranch Hand

Joined: Jun 23, 2004
Posts: 172

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

SCJP 1.4 (91%)<br />SCJD 1.4 (376/400, 94%)
Javini Javono
Ranch Hand

Joined: Dec 03, 2003
Posts: 286

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.

Javini Javono
[ July 02, 2004: Message edited by: Javini Javono ]
With a little knowledge, a cast iron skillet is non-stick and lasts a lifetime.
subject: Aaak! Javadoc comments!
Similar Threads
style guide
URLyBird interface javadoc?
Document Accessors ? A matter of Style
write to a file without delete it (noob question)
Question about comments