File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
http://aspose.com/file-tools
Win a copy of Clojure in Action this week in the Clojure forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Must the provided docs be included in the Javadocs?

 
Juan M.
Greenhorn
Posts: 6
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Posts: 85
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic