• 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

access modifiers

 
Greenhorn
Posts: 3
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
hello friends,
i minimize access rights as much as possible-- ie, most members are package or private. only mandatory public members.
now i've never dealt with javadoc before. and we're only supposed to javadoc publicmembers.
1. should all method comments be in javadoc format, even if they aren't public and won't be javadocified?
2. is it screwed up to minimize use of public, which results in a sparse javadocument collection?
i might have the wrong approach to structuring java to start with, so i will appreciate any enlightenment on these issues.
 
Ranch Hand
Posts: 213
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
All methods should be javadoced, but only submit to sun your protected javadoc.
This allows anyone that was going to resuse your code without access to source to do that, and anyone that does have access to source is covered as well.
 
reply
    Bookmark Topic Watch Topic
  • New Topic