• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Documentation/JavaDoc Question

 
Alexander Duenisch
Greenhorn
Posts: 24
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
My assignment paper is somewhat unclear about which functions are required to be documented in JavaDoc format. So far i used JavaDoc comments only for public and protected methods (the ones that could be of interest for external users). For private methods i used plain comments. How did you go about this?

Thanks,
alex
 
mohamed sulibi
Ranch Hand
Posts: 169
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
hi;

i think it is ok because you don't break the assignment, for me i comment all things as javadoc also private memeber.

regards.
Mohamed Darim.
 
Eric Ushie
Ranch Hand
Posts: 31
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Alexander,

You can also appreciate javadoc comments from the point of view of maintenability. If another developer - possibly a younger guy is to inherit your code, are they likely to flow with your logic without explanation (comments)?

This should also affect your basis for writing javadoc be it for private, public or protected members

Best Regards.
 
rinke hoekstra
Ranch Hand
Posts: 152
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I just javadoc'ed everything. Is very clear (also for myself).

When generating the javadoc files, I will just generate the public elements.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic