Java™ Application Development on Linux - Dator

130Chapter 5The Sun Microsystems Java Software <strong>Development</strong> Kit@exception or @throwsOnly valid in the comment for a method or constructor. This tag isfollowed by the name of an exception class (a descendant ofjava.lang.Exception) and optionally by additional explanatory text.The intent is to list the exceptions that the method throws.@paramOnly valid in the comment for a method or constructor. This tag shouldbe followed by the name of a parameter to the method followed by descriptivetext. This is used to document method and constructor parameters.@returnOnly valid in the comment for a method. 7 This tag is followed bydescriptive text meant to document the return value of the method.@seePopulates a “See Also” section in the documentation that will providehyperlinks to related content. There is a general format for linking to anyURL, but the most common use is to refer to other elements in the sameJava program. See below for the general format of such links.In addition to these standard at-tags, there are other at-tags that may beembedded in any comment text—either the comment itself or in text that isan argument to a standard at-tag.Such tags are placed within curly braces, for example {@example}, withina Javadoc comment. The one we use the most is the @link tag, which allowsyou to make a reference to another package, class, method, or class member.The general format is the same as that for the @see tag:package_name.class_name#member_or_method_nameAny of these elements is optional.The embedded at-tags include:@docRootThis tag may be used when embedding HTML anchor or image tags(A or IMG tags) in a Javadoc comment to supply the root part of the7. But not a constructor in this case, because constructors cannot return a value.