• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Javadoc - only public members?

 
Michael Gonzalez
Greenhorn
Posts: 2
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
hi guys,

The instructions say that "and javadoc style comments must be used for each element of the public interface of each class."

Does it mean we can/should leave the not public methods/variables of the classes undocumented?

What did you do?


Thanks!
 
Roberto Perillo
Bartender
Posts: 2271
3
Eclipse IDE Java Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Greetings, champion. Welcome to our JavaRanch!

Well, the instructions say that at least the public elements of your API should have JavaDocs. I myself included JavaDocs for all elements, including private ones.

Also, please take a look at your private messages, regarding an important administrative information.
 
Roel De Nijs
Sheriff
Posts: 10662
144
AngularJS Chrome Eclipse IDE Hibernate Java jQuery MySQL Database Spring Tomcat Server
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I created javadoc comments for public, protected, default and private classes and members. I haved generated javadoc documentation for all but private classes and members.
 
Michael Gonzalez
Greenhorn
Posts: 2
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Roel De Nijs wrote:I created javadoc comments for public, protected, default and private classes and members. I haved generated javadoc documentation for all but private classes and members.


thanks Roel. I asked because at the beginning i wanted to just generate it for everything to be safe but i quickly realized that doing it for every little private variable in the class is way too tedious and repetitive. I will do the same as you did.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic