• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

How to write document?

 
Daniel Chen
Greenhorn
Posts: 24
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Posts: 125
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
aho Daniel,
Could you explain better?
greetings
 
Anonymous
Ranch Hand
Posts: 18944
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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.
Cheers
Torgny
 
Pete Lyons
Ranch Hand
Posts: 109
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic