Win a copy of Java Mock Exams (software) this week in the Programmer Certification (OCPJP) forum!
  • Post Reply Bookmark Topic Watch Topic
  • New Topic

Recoment the implemented methods?

 
Gabriel Ozeas
Ranch Hand
Posts: 30
Google App Engine Hibernate jQuery
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hello guys,

I always have the curious to know if it's necessary recoment the methods that are been implemented. They are already comented in the interface, and as i read the doc comments can't have details of implementation. And if they have the same funcionality describing in the interface, why i need to recomment? What about OCJD? Like DB.java and Data.java for example.

Bye, bye
 
Roel De Nijs
Sheriff
Posts: 10763
148
AngularJS Chrome Eclipse IDE Hibernate Java jQuery MySQL Database Spring Tomcat Server
  • Likes 1
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I use a lot of {@inheritDoc} in my comments, like this:
 
Gabriel Ozeas
Ranch Hand
Posts: 30
Google App Engine Hibernate jQuery
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thanks so much Roel. I didn't know about this tag. HEHE

Bye bye
 
Jonathan Elkharrat
Ranch Hand
Posts: 170
Ubuntu
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
i think by default the generated html includes a line like that:

Specified by:
MethodName in interface InterfaceName

so you could write a very simplistic description ("add a record to the database")
and if someone want to know more he just have to click the interfaceName...
 
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!