File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
http://aspose.com/file-tools
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes How to comment the inherited method. 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 comment the inherited method." Watch "How to comment the inherited method." New topic
Author

How to comment the inherited method.

Zhixiong Pan
Ranch Hand

Joined: Jan 25, 2006
Posts: 239
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.


SCJP 1.4 SCJD
Rudolph Jen
Ranch Hand

Joined: Nov 17, 2006
Posts: 37
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.


SCJP<br />SCJD (in progress)
Zhixiong Pan
Ranch Hand

Joined: Jan 25, 2006
Posts: 239
Hi Rudolph,
You helped me a lot.Thanks.
BTW, need I add comments to classes like DuplicateKeyException or Java beans like FieldInfo.
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: How to comment the inherited method.
 
Similar Threads
nx:All of URLy Bird 1.1.3 about javadoc comments
Seat references in the Segment
using JSP to read SQL data
DuplicateKeyException revisit
Java Doc DB interface!