• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Javadoc documentation requirements

 
Janne Karhu
Ranch Hand
Posts: 33
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hello! How do you guys interpret this requirement: "...and javadoc style comments must be used for each element of the public interface of each class". Do I always have to actually add a javadoc-comment to my public method, even if the method inherits a proper documentation (or part of it)from the interface it implements? Can Sun fail me automatically if all the public methods do not contain explicitly written javadoc-documentation, even if the corresponding Javadocs-page contains one?
 
Vlad Rabkin
Ranch Hand
Posts: 555
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Posti,

"Do I always have to actually add a javadoc-comment to my public method..."

Yes, you do, regarless other facts.
Can Sun fail me automatically if all the public methods do not contain explicitly written javadoc-documentation, even if the corresponding Javadocs-page contains one?

I wouldn't take a risk.
Best,
Vlad
[ October 29, 2003: Message edited by: Vlad Rabkin ]
 
Andrew Monkhouse
author and jackaroo
Marshal Commander
Pie
Posts: 12014
220
C++ Firefox Browser IntelliJ IDE Java Mac Oracle
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi
Welcome to JavaRanch.
Please check your Personal Messages (here) - I have sent you a message about your displayed name.
Personally I used the inheritance feature of JavaDoc to reduce my workload. I put an "//inherited from ...." comment above every method that only used inheritance to populate the javadoc, so someone reading the code would know why I did not have complete javadoc for that method (and would also know that the method had to meet the contract specified in the interface / super class).
I got 100% for my documentation.
Regards, Andrew
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic