Thursday, December 22, 2016

API(Application Programming Interface):

API(Application Programming Interface):

---------------------------------------------------------------------------------------------------------------------
In General we will utilize documentation comment to prepare API kind of documentation, but it is not suggestible because it is
time taking process.

To simplify API documentation preparation, JAVA has provided an implicit comment in the form of "javadoc".

Note: Gathering declarative information of all the programming elements which we provided in the present java program
is called as "API Documentation". API documentation may be available in .html file, .pdf file, .doc file....

"javadoc" command is able to provide API documentation in the form of html files.

Example: file name:C:\abc\Employee.java
----------------------------------------------------------

public class Employee implements java.io.Serializable, Cloneable
{
public String eid;
public String ename;
public float esal;
public String eaddr;

public Employee()
{
}

public Employee(String eid)
{
}

public Employee(String eid, String ename)
{
}

public Employee(String eid, String ename, float esal)
{
}

public Employee(String eid, String ename, float esal, String eaddr)
{
}

public void add(String eid, String ename, float esal, String eaddr)
{
}

public void delete(String eid)
{
}

public void search(String eid)
{
}
}
----------------------------------------------------------------------------------------------------------

On command prompt:
C:\abc>javadoc Employee.java
----xxx.html files are generated-----

No comments:

Post a Comment