JAVA学习之注释

文档注释

类注释

类注释必须放在import语句之后，类定义之前。

使用/*......*/

方法注释

每一个方法描述必须放在所描述的方法前。

@param 变量描述 对当前部分的参数部分添加一个描述。一个方法的该标记必须放在一起。

@return 描述 对当前方法添加一个返回部分。

@throws 添加一个注释，表示这个方法可能抛出异常。

域注释

只需要对公有域（通常指的是静态常量）建立文档。

通用注释

下面的标记可以用在类文档的注释中：

@author 姓名 可以使用多个，来增加一个author项。

@oversion 产生一个版本描述。

@since文本 产生一个始于条目，例如：@since version 1.7.1

@deprecated 文本对类或变量添加一个不再使用的注释。

@see 引用 将在“see also”部分增加一个超链接。

包与概述注释：提供一个以package.html命名的HTML文件，在<body>标签中的文本将被抽取出来。

注释的抽取：（1）切换到包含想要生成文档的源文件目录。

（2）运行命令：Javadov -d docDirectory 包名（可以有多个）。