• 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

Javadoc - only public members?

 
Greenhorn
Posts: 2
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • 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!
 
Bartender
Posts: 2292
3
Eclipse IDE Spring Java
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • 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.
 
Sheriff
Posts: 11604
178
Hibernate jQuery Eclipse IDE Spring MySQL Database AngularJS Tomcat Server Chrome Java
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • 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
    Number of slices to send:
    Optional 'thank-you' note:
  • 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.
 
Consider Paul's rocket mass heater.
reply
    Bookmark Topic Watch Topic
  • New Topic