• Post Reply Bookmark Topic Watch Topic
  • New Topic

JAvaDoc of given Interface

 
Anton Brass
Greenhorn
Posts: 25
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hey there,

just started today with looking on the UrlyBird exam. There I must implement a given class DB. Well the commentary is very poorly written and not really conform.

Do I have to let the interface documentation as it is or can I rewrite respectively add for example param documentation ?

 
Roberto Perillo
Bartender
Posts: 2273
3
Eclipse IDE Java Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Howdy, Anton!

Champ, here's what I did: I just changed the comments of the given interface to the JavaDoc format. So I added all the proper JavaDoc tags to the methods, but I kept the text of the methods as they were provided to me.
 
Roel De Nijs
Sheriff
Posts: 10763
148
AngularJS Chrome Eclipse IDE Hibernate Java jQuery MySQL Database Spring Tomcat Server
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Anton,

I kept the interface as I got it, just added some class javadoc comments.

Kind regards,
Roel
 
Anton Brass
Greenhorn
Posts: 25
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
hey guys,

thanks for the advice, I did the same. Just was confused, since the exam is also about proper JavaDoc and the only class Sun provides has awfull respectively no JavaDoc ;)
 
Happiness is not a goal ... it's a by-product of a life well lived - Eleanor Roosevelt. Tiny ad:
the new thread boost feature: great for the advertiser and smooth for the coderanch user
https://coderanch.com/t/674455/Thread-Boost-feature
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!