Java Programming Compassionate a Java Program Javadoc and additional comments

 18 June 09:04   Beneath is an enhancemnt to the Ambit chic which we presented in

    .

    If you accept not already apprehend that module, amuse do so now to accustom yourself

    with the purpose and anatomy of this sample class.

    Lets analysis our Ambit chic as it was initially coded:

     accessible chic Distance

    

     accessible abandoned printDistance()

    

     accessible changeless abandoned main(String[] args)

    

     clandestine changeless int intValue(String data)

    

     }

    One affair you may apprehension is the absence of antecedent cipher

     which

    describe the chic and its implementation.

    This was advised so that we could use prose

    in

    to certificate the class.

    While a baby or abundantly authentic Java program such as this

    one is generally clear after comments, comments can aid in compassionate added complex

    Java classes. Alotof notably, comments can advice specify the application

    programming interface by anecdotic what anniversary adjustment does,

    what ethics the methods return, and what

    the constraints of their inputs have.

    The bore discusses Java comments

    in added detail. We will add acceptable comments so that anyone looking

    at the antecedent can accept how it is implemented and

    its the API and its constraints. This will create it easier to use the

    class elsewhere, to extend it by abacus functionality, or to make new

    classes which extend it.

    We will add comments anon afore anniversary of the capital declared elements:

    the chic itself and its fields, constructor, and methods.

     / accessible chic Distance

    

     / accessible abandoned printDistance()

    

     / accessible changeless abandoned main(String[] args)

    

     / clandestine changeless int intValue(String data)

    

     }

    You may apprehension that we breach the decaration of the fields

     clandestine java.awt.Point point0, point1;

    into two separate declarations so that we could accommodate a

    separate animadversion for anniversary field.