Granny's Programming Pearls
"inside of every large program is a small program struggling to get out"
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes documentation Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login
JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Bookmark "documentation" Watch "documentation" New topic


Alex Gregory
Ranch Hand

Joined: Jun 15, 2002
Posts: 46
hi guys, how much documentation should I do for the UnicastRemoteObject for the server which encapsulates the 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

Joined: Feb 05, 2001
Posts: 17276

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.

Perfect World Programming, LLC - iOS Apps
How to Ask Questions the Smart Way FAQ
I agree. Here's the link:
subject: documentation
It's not a secret anymore!