• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

I have a question on documentation.

 
Ya Zhang
Greenhorn
Posts: 3
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi everyone:
I just start my scjd exam, I have a question on documentation.
I am not sure that should I provide the documentations at the begining of every class (likes below)?and should I provide javadoc type documentation for every method of each class ?
 
Fisher Daniel
Ranch Hand
Posts: 582
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Ya Zhang,

I think we should document all methods and attributes at each class.
And we have to describe clearly every class which we developed.

Correct me if I am wrong..

thanks
daniel
 
Ya Zhang
Greenhorn
Posts: 3
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi:
My instruction siad that "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".
so, I think that I do not need to document those methods that do not with the "public" keyword. and is it necessary to provide the class description comments at the beginning of every class?
 
Inuka Vincit
Ranch Hand
Posts: 175
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Originally posted by Ya Zhang:
Hi:
My instruction siad that "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".
so, I think that I do not need to document those methods that do not with the "public" keyword. and is it necessary to provide the class description comments at the beginning of every class?


Both at school and work(more so). Documenting every thing mehtod is a must. Definitley do each method. I think what they are refering to is line comments. The requirements also says a Junior programmer should be able to understand the code easily.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic