• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

How to comment the inherited method.

 
Zhixiong Pan
Ranch Hand
Posts: 239
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi ranchers,
I am writing comments for the assignment. Ask a simple question: there are many methods in Data class inherit from DB interface; where should I put the comments? Should the given explanation in DB be removed?Thanks.
 
Rudolph Jen
Ranch Hand
Posts: 37
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
No, don not remove.

1. Change provided comments for DB-Interface into javadoc
// blablabla
in
/*
blabla
*/
2. Just link the javadoc from the Implementation to the Interface
Data implements DB
..
/*
* (non-javadoc)
* @see suncertify.db.DB#delete(int,long)
public void delete(int recNo, long cookie)
3. Generate javadoc and check the result

That's it.
 
Zhixiong Pan
Ranch Hand
Posts: 239
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Rudolph,
You helped me a lot.Thanks.
BTW, need I add comments to classes like DuplicateKeyException or Java beans like FieldInfo.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic