aspose file tools*
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes Java Doc DB interface! Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "Java Doc DB interface!" Watch "Java Doc DB interface!" New topic
Author

Java Doc DB interface!

Rach Mand
Greenhorn

Joined: Feb 29, 2008
Posts: 3
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

Joined: Apr 26, 2005
Posts: 516
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

Joined: Sep 04, 2005
Posts: 169
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).
 
It is sorta covered in the JavaRanch Style Guide.
 
subject: Java Doc DB interface!