javaDoc注释

概述

Javadoc是Sun公司提供的一项自动生成帮助文档技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签和格式编写注释，在程序完成后，通过Javadoc就可以同时形成程序的帮助文档。

注释类型

javaDoc标记	描述
@version	指定版本信息
@since	指定最早出现版本
@author	指定作者
@see	添加参见标题，其中有指向reference的链接或者文本项。@see标签有三种形式，下面分别说明： 1.@see “string” 为"string"添加文本项，不产生链接。 2.@see <a href=“URL#Value”>Label使用HTML标记产生链接 3.@see package.claJss#member Label 使用Java语言的名字package.class #member产生链接，与@link类似。
@link	生成参考链接，为特定词汇生成链接 {@link package.class#member label} 插入指向package.class#member的内嵌链接
@deprecated	标记过期方法，不提倡使用
@param	参数
@return	返回值
@throw	描述抛出的异常，说明抛出的条件

几张图例