浅析java的类文档标记和方法文档标记

　　随同嵌入html和@see引用，类文档还可以包括用于版本信息以及作者姓名的标记。类文档亦可用于“接口”目的(本书后面会详细解释)。

　　1. @version

　　格式如下：

　　@version 版本信息

　　其中，“版本信息”代表任何适合作为版本说明的资料。若在javadoc命令行使用了“-version”标记，就会从生成的HTML文档里提取出版本信息。

　　2. @author

　　格式如下：

　　@author 作者信息

　　其中，“作者信息”包括您的姓名、电子函件地址或者其他任何适宜的资料。若在javADOc命令行使用了“-author”标记，就会专门从生成的HTML文档里提取出作者信息。

　　可为一系列作者使用多个这样的标记，但它们必须连续放置。全部作者信息会一起存入最终html代码的单独一个段落里。

　　除嵌入HTML和@see引用之外，方法还允许使用针对参数、返回值以及违例的文档标记。

　　1. @param

　　格式如下：

　　@param 参数名 说明

　　其中，“参数名”是指参数列表内的标识符，而“说明”代表一些可延续到后续行内的说明文字。一旦遇到一个新文档标记，就认为前一个说明结束。可使用任意数量的说明，每个参数一个。

　　2. @return

　　格式如下：

　　@return 说明

　　其中，“说明”是指返回值的含义。它可延续到后面的行内。

　　3. @exception

　　有关“违例”(Exception)的详细情况，我们会在第9章讲述。简言之，它们是一些特殊的对象，若某个方法失败，就可将它们“扔出”对象。调用一个方法时，尽管只有一个违例对象出现，但一些特殊的方法也许能产生任意数量的、不同类型的违例。所有这些违例都需要说明。所以，违例标记的格式如下：

　　@exception 完整类名 说明

　　其中，“完整类名”明确指定了一个违例类的名字，它是在其他某个地方定义好的。而“说明”(同样可以延续到下面的行)告诉我们为什么这种特殊类型的违例会在方法调用中出现。

　　4. @deprecated

　　这是Java 1.1的新特性。该标记用于指出一些旧功能已由改进过的新功能取代。该标记的作用是建议用户不必再使用一种特定的功能，因为未来改版时可能摒弃这一功能。若将一个方法标记为@deprecated，则使用该方法时会收到编译器的警告。