Win a copy of The Little Book of Impediments (e-book only) this week in the Agile and Other Processes forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Java Docs

 
Lee Sunter
Greenhorn
Posts: 29
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
This is my assignment requirement for Java Docs

The code itself should be as clear as possible; do not provide comments that do not add to the comprehensibility of the code. 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. You must create a full suite of documentation for the classes of the completed project. This must be generated using the tool "javadoc" and must be in HTML format. Provide javadoc documentation for all classes you write.

does this mean I should or should not provide Java docs for my private methods, if not should they just be normal comments? or do you put them in for eveything?

Thanks
Lee
 
Jan Groth
Ranch Hand
Posts: 456
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
that's kind of up to you. the requirements are clear, all classes plus all public method.

but there will also be a scoring section judging your coding style and so on...

i wrote javadoc for all classes, all methods & all fields.

many greetings,
jan
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic