•  Print this page
    Print this page

Java Quick Guide
 
 
This guide contains useful Java information.

Quick guides







Javadoc Comments.



Information
The Javadoc Comments documentation can be found online on the java.sun.com website, see: http://java.sun.com/j2se/javadoc/writingdoccomments/index.html

Javadoc comments are identified by /** ... */ delimiters,
Regular comments are identiefied by // or /* .. */ delimiters.

Javadoc tagsDescription
@author [author name] identifies author(s) of a class or interface.
@version [version] version info of a class or interface
@param [argument name] [argument description] describes an argument of method or constructor.
@return [description of return] describes data returned by method (unnecessary for constructors and void methods).
@exception [exception thrown] [exception description] describes exception thrown by method.
@throws [exception thrown] [exception description] describes exception thrown by method.