Skip to Main Content

Java APIs

Announcement

For appeals, questions and feedback about Oracle Forums, please email oracle-forums-moderators_us@oracle.com. Technical questions should be asked in the appropriate category. Thank you!

Best Pratices

843810Sep 24 2009 — edited Nov 17 2009
Hello

I do not know if this is the best place for this post, but after searching for "java documentation best practices" in google the results were not very clear and direct.

For instance, I have an interface (e.g. ExampleInterface) and a Class (e.g. ImplmentsExampleInterface) that implements the ExampleInterface.

The "ImplmentsExampleInterface" will have no code, just the "ExampleInterface" overwritten methods and then I will have several other Class's that will extend "ImplmentsExampleInterface", and it will be this Classes that will contain the code.

I only ask for pointers to proper place that has examples and information on how to properly comment/document this kind of structure, for instance, should I document everything (interface, super class, and class's) even if it is copy paste? Or should I put the effort in commenting the diferences betewen the bottom Class's?

Regards
Cad
Comments
Locked Post
New comments cannot be posted to this locked post.
Post Details
Locked on Dec 15 2009
Added on Sep 24 2009
1 comment
1,031 views