• Post Reply Bookmark Topic Watch Topic
  • New Topic

URLyBird interface javadoc?

 
Michael Case
Greenhorn
Posts: 1
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
The instructions say "Your data access class must be called "Data.java", must be in a package called "suncertify.db", and must implement the following interface:"

Now this may be a stupid question, but I'm curious what everyone's opinion is about putting javadocs on that interface. The source in my instructions contains several lines of non javadoc documentation for each method. My gut instinct is to turn those into javadocs, but I have a slight worry that the source will now differ (even though the java is the same) and I might fail some type of automated check. Any advice from those who have passed the SCJD?

Thanks
 
Jevgeni Zhukov
Greenhorn
Posts: 18
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi
That is OK if you change those comments to Javadoc, IMHO you have to do that.
 
Jethro Borsje
Ranch Hand
Posts: 100
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I had the same problem and decided to convert the comments in the provided interface into JavaDoc.
 
my overalls have superpowers - they repel people who think fashion is important. Tiny ad:
the new thread boost feature brings a LOT of attention to your favorite threads
https://coderanch.com/t/674455/Thread-Boost-feature
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!