• Post Reply Bookmark Topic Watch Topic
  • New Topic

access modifiers  RSS feed

 
Esem Tax
Greenhorn
Posts: 3
  • Mark post as helpful
  • send pies
  • 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.
 
Matt Ghiold
Ranch Hand
Posts: 213
  • Mark post as helpful
  • send pies
  • 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.
 
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!