Mega Code Archive
Documentation(JavaDoc)
<![CDATA[
A documentation comment begins with /** and ends with */.
/**
This is a documentation comment.
*/
A documentation comment can also include HTML tags, and special tags beginning with @.
The @ character is followed by a keyword that defines the purpose of the tag.
CommandMeaning
@authorDefines the author of the code.
@deprecatedIndicates deprecated methods.
@exceptionDocuments exceptions
{@link}Generates a link.
@paramDescribes the parameters for a method.
@returnDocument the value returned from a method.
@seeUsed to specify cross-references to some other part of the code.
@throwsA synonym for @exception.
@versionUsed to describe the current version of the code.
/**
@author your name
*/
public class MainClass{
/**
@exception IOException When an I/O error occurs.
*/
public static void main(String[] ){
}
}
]]>