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

documentation

 
Alex Gregory
Ranch Hand
Posts: 46
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
hi guys, how much documentation should I do for the UnicastRemoteObject for the server which encapsulates the Data.java class? The question is how many times do i have to document the same method in different classes which use the same class? Also, how do they want us to handle exceptions? Do they just want us to put print statements in catch blocks? Thanks
 
Mark Spritzler
ranger
Sheriff
Posts: 17278
6
IntelliJ IDE Mac Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
For handling exceptions, I think it is important that the "Person" who needs to know about it, hears about it. If your server is console based then out.printlns are fine. If you ahve a GUI for you server, then a nice popup showing the problem is a good idea. If the client gets a problem, then the user should also get a nice popup, so that it knows something went wrong.
Using JavaDocs Methods that are inherited will get the JavaDoc from the original class, so you won't have to duplicate the typing.
Mark
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic