1 Reply Latest reply: Nov 17, 2009 7:10 PM by 843810 RSS

    Best Pratices


      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?

        • 1. Re: Best Pratices
          Look at the source code for the JSE standard library included in the JDK for an example of Javadoc best practices. In general I would focus on documenting the interface; the method documentation will then be automatically inherited by the implementation classes.

          Edited by: Nick_Radov on Nov 17, 2009 5:09 PM