JavaDoc Tags

/** starts a JavaDoc comment, first line is summary */ ends

@link classname – link to the Java docs for a class

@param paramname description – describe a parameter of a method or constructor only

@return description – what does this method return

@see classname – see also some other class

@author name – can have more than one, for classes and interfaces only

@version number – set a version number for classes only

@exception – this throws an exception you can link to the docs for

@since – what version of Java has this been available since

@serial – serial number

@deprecated – don't use deprecated stuff