Saturday, September 24, 2011

Javadoc & its tags

What is a Javadoc - Javadoc Comments are specific to the Java language and provide a means for a programmer to fully document his / her source code as well as providing a means to generate an Application Programmer Interface (API) for the code using the javadoc tool that is bundled with the JDK. These comments have a special format.

Example -

/**
* This is sample javadoc.
*/

Some of its tags:

@author
@version
@param
@return
@throws
@see
@since
@deprecated


Helpful links: Link1, Link2

No comments:

Post a Comment