• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Java Doc DB interface!

 
Rach Mand
Greenhorn
Posts: 3
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Guys,
This is my first post. Well i am doing URLyBirdApplication 1.1.3. In my spec they say "Awkward or complex code should have descriptive comments, and javadoc style comments must be used for each element of the public interface of each class". Does that mean i have to javadoc my DB interface as well? The reason i am asking this is because i understand i should not be changing the DB interface that they gave me . Am i right? . If i javadoc it ,would it not be a case where i am actually changing the DB interface?

Thanks
 
Alex Belisle Turcot
Ranch Hand
Posts: 516
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Originally posted by Rach Mand:
Hi Guys,
This is my first post. Well i am doing URLyBirdApplication 1.1.3. In my spec they say "Awkward or complex code should have descriptive comments, and javadoc style comments must be used for each element of the public interface of each class". Does that mean i have to javadoc my DB interface as well? The reason i am asking this is because i understand i should not be changing the DB interface that they gave me . Am i right? . If i javadoc it ,would it not be a case where i am actually changing the DB interface?

Thanks


Hi,

I personally added javadoc to the Java file provided by SUN (just copying the comments that SUN provided). However, as required, I did not modified the Interface. I add 100% for documentation.

Regards,
Alex
 
mohamed sulibi
Ranch Hand
Posts: 169
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
hi;

i don't submit yet, but i alter the java doc in the provided interface by sun , i add the @throw and @return @param to the comments. i think it is not matter to keep the comment in the sun interface as is.

Best regards.
Mohamed Darim SCJP, SCJD in progress ... (upload date: 1/may/2008 i don't have enough money to submit it in : 1/april/2008).
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic