permaculture playing cards*
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes javadocs 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 "javadocs" Watch "javadocs" New topic


Hung Tang
Ranch Hand

Joined: Feb 14, 2002
Posts: 148
How much details is required for doing javadocs? Do I have to describe member/class variables with javadoc?? I noticed that Sun didn't do that with the completed classes (DataInfo, FieldInfo) that came bundled with the assignment. Also regarding to inner classes, are you suppose to javadoc them as well? I have a few listener classes that overrides the ActionPerformed method, isn't it self explanatory and I shouldn't have to javadoc it?
Maybe a comment is nice, but is it necessary? anyone?
Siddharth Mehrotra
Ranch Hand

Joined: Aug 21, 2001
Posts: 185
The extent to ehich you should do javadoc depends on you.
I dont think that u have to document member and class variables.
but yes if you have an interface where you ahve some variables that u will have to add in javadoc.
in case of your other problem,about documenting innerclasses, i guess that will come under the category of commenting your code and not under javadoc
I hope i have cleared you enough..
Best of luck

I agree. Here's the link:
subject: javadocs
Similar Threads
What exctly the Future class in concurrent package of util?
How to comment adapter classes
Creating javadocs for "published" API vs public API
How to perform multi-level sorting in java?
How to get rid of java.lang.String refs in JavaDoc