• Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other Pie Elite all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Jeanne Boyarsky
  • Ron McLeod
  • Paul Clapham
  • Liutauras Vilda
Sheriffs:
  • paul wheaton
  • Rob Spoor
  • Devaka Cooray
Saloon Keepers:
  • Stephan van Hulst
  • Tim Holloway
  • Carey Brown
  • Frits Walraven
  • Tim Moores
Bartenders:
  • Mikalai Zaikin

javadocs

 
Ranch Hand
Posts: 148
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • 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?
 
Ranch Hand
Posts: 185
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • 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
 
reply
    Bookmark Topic Watch Topic
  • New Topic