Class Header Comments

Header comments for the class should provide descriptive information about the class, and may optionally include additional tags, indicating version and author:

/**
* class description
*
* @version 1.0
* @author amachado
*/

Class Header Comment Tags

The following are the suggested tags for commenting class headers.

Tag	Description
@version number	Specify a version number for a class.
@author name	Specify an author for a class.