aspose file tools*
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes Must the provided docs be included in the Javadocs? Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login


Win a copy of Spring in Action this week in the Spring forum!
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "Must the provided docs be included in the Javadocs?" Watch "Must the provided docs be included in the Javadocs?" New topic
Author

Must the provided docs be included in the Javadocs?

Juan M.
Greenhorn

Joined: Jan 04, 2005
Posts: 6
Hi,

Well, first hello to everybody. This is going to be my first post in this forum.

I'm a bit paranoid about this assignment. Must the documentation provided be included in the javadoc? An example: it gives the database file info. Would it be correct to add it to a �DBFileManager� type of class ? Certainly, from a programmers point of view, it is. On the other hand, Javadoc is supposed to provide information about *what* a method, class, etc does, and not *how* it does it. Since docs will be evaluated, do you know what is the correct option in this project ?

Any comment would be really welcome !
Dieskun Koper
Ranch Hand

Joined: Aug 15, 2004
Posts: 85
Hi Juan,

I did not include the schema from the instructions in my javadoc and got full score for documentation (70/70).
Although I agree from the programmer's perspective you'd feel like including it in your source (as some of your DB methods rely on it), it is a maintenance hassle to have it in two places. I think the schema should be in the FD (instructions.html) as other programs rely on it (the legacy program mentioned in the instructions). IMHO, I don't think everything in an FD should be copied into the source.

Regards,
Dies
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: Must the provided docs be included in the Javadocs?