The Java style of coding has been set by Javasoft at Sun.
It consists of coding rules for Documentation Comments which summarized by their tags
Here is a Summary of the Tags:
Class and Interface Documentation Tags
@author D.Lyon ,
@version 1.0,
@see lyon.gui.Frame,
@since jdk1.2 ,
@deprecated lyon.gui.ShortCutFrame,
@see #PetriFrame
The tricky bit is the deprecated tag, which is typically followed by the see tag. The see tag shows the class to use instead of the deprecated class. The see tag can be used with a # to indicated a method that is local to the Class.
Constructor and Method Documentation Tags
@param start The start of the count,
@return some instance,
@exception fully-qualified-class-name description,
@see classname,
@since since-text,
@deprecated deprecated-text
updated 12/30/99 CopyRighted by DocJava, Inc.