• 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 all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Bear Bibeault
  • Ron McLeod
  • Jeanne Boyarsky
  • Paul Clapham
Sheriffs:
  • Tim Cooke
  • Liutauras Vilda
  • Junilu Lacar
Saloon Keepers:
  • Tim Moores
  • Stephan van Hulst
  • Tim Holloway
  • fred rosenberger
  • salvin francis
Bartenders:
  • Piet Souris
  • Frits Walraven
  • Carey Brown

Javadoc documentation requirements

 
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?
 
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 ]
 
author and jackaroo
Posts: 12199
280
Mac IntelliJ IDE Firefox Browser Oracle C++ Java
  • 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
 
Lookout! Runaway whale! Hide behind this tiny ad:
Building a Better World in your Backyard by Paul Wheaton and Shawn Klassen-Koop
https://coderanch.com/wiki/718759/books/Building-World-Backyard-Paul-Wheaton
    Bookmark Topic Watch Topic
  • New Topic