• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Question about javadoc

 
Iván Párraga
Ranch Hand
Posts: 54
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,

In my instructions can be read:


Where this document uses the word "must" an absolute requirement is being described. If you fail to adhere to such a requirement, your assignment will be failed automatically, and without further evaluation ../.. Portions os your submission will be analyzed by software ../..


and later in the document:


../.. javadoc style comments must be used for each element of the public interface of each class ../..


When working with interfaces it is very common that the documentation required by the methods in the implementing class, are exactly the same than the ones in the methods' signatures of this interface. Thanks to the @super annotation and the intelligence of javadoc, this documentation is generated in both places (the interface and the implementing class). Is this enough for the assignment? or an automated robot will be looking for javadoc comments (ignoring @super) in my source code?

I think is is useless and a barrier to maintenance to have to replicate all these comments.

Cheers,

Iv�n
 
Iván Párraga
Ranch Hand
Posts: 54
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
where I say @super annotation I mean @override

cheers,

Ivań
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic