jQuery in Action, 3rd edition
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes How to write document? 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 "How to write document?" Watch "How to write document?" New topic

How to write document?

Daniel Chen

Joined: Oct 07, 2002
Posts: 24
There are some interface and class implement these interface in my design.Do I need document all these same public methods with the same or familiar words?
Andrea Gazzarini
Ranch Hand

Joined: Sep 09, 2002
Posts: 125
aho Daniel,
Could you explain better?

Regards,<br />Andrea<br /> <br /><a href="http://www.linkedin.com/in/andreagazzarini" target="_blank" rel="nofollow">Andrea Gazzarini</a><br />Skype ID : gazzax72<br />Google Talk ID : a.gazzarini@gmail.com<br /><a href="http://www.andreagazzarini.blogspot.com" target="_blank" rel="nofollow">My Blog</a>
Ranch Hand

Joined: Nov 22, 2008
Posts: 18944
One way of finding out how docmunentation could be written is to read the API documentation and also check the java sources in src.zip located in JAVA-HOME.
Pete Lyons
Ranch Hand

Joined: Aug 18, 2002
Posts: 109
I believe Daniel is asking that once he has written the JavaDoc for all the methods in an interface, how should he document the methods of the classes that implement it. I was unsure about this as well. Javadoc will automatically copy the comments from the interface for you if you omit javadoc in the implementation, but I was worried about that, so I added brief implementation comments with @see links to the interface, which had the verbose definition of the method contract.
I agree. Here's the link: http://aspose.com/file-tools
subject: How to write document?
It's not a secret anymore!