Win a copy of Programmer's Guide to Java SE 8 Oracle Certified Associate (OCA) this week in the OCAJP forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

javadocs

 
Hung Tang
Ranch Hand
Posts: 148
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Posts: 185
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic