• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

need help uuuuuuurgentlyyyyyyy

 
Bhuvan mehra
Ranch Hand
Posts: 69
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Documentation (Total 20)
= = = = = = = = == = = = =
user documentation (10) // ???
javadoc source documentation (5) // javadoc tags for all the members of class. Do I need to give info. about even var. using javadoc tags.
comments (5) //???
Pls. give your response asap.
Thanks and regards,
bhuvan
 
Colin Froggatt
Greenhorn
Posts: 10
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Bhuvan, I believe the spec says you must produce Java doc for ALL public elements of class'. SO if you have public attributes, then yes you will need to javadoc those.
I'm currently going through this process at the moment and I have decided, as a matter of style which would aid maintainability, to javadoc all methods and all other significant elements.
 
Bhuvan mehra
Ranch Hand
Posts: 69
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
thanks for response. i will doc for only public elements.
any detail about
user documentation (10) // ???
comments (5) //???
few hrs. left for my exam. need response urgently.
thanks andd grdars,
bhuvan.
 
Mark Spritzler
ranger
Sheriff
Posts: 17278
6
IntelliJ IDE Mac Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Comments are the comments you have in your code. In the spec it states to make sure you don't overdo them. Meaning if the code is self-explanitory then you don't need to comment. However in some parts you will. Like describing your search algorithm briefly. What you did to the Deprecated method, et al.
The User Documentation is explaining how to use your app. For instance on the client side, if a User has never used your app, what are the step the user needs to search a flight, what to do to book a flight, et al. If you have a GUI on your server side, a user documentation would explain how to use it.
Mark
 
Bhuvan mehra
Ranch Hand
Posts: 69
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
thanks Marks,
thanks again.
regards,
bhuvan.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic