【文档注释】文档注释

方法注释

·@param 变量描述——当前方法使用的参数

·@return 描述——返回部分

·@throws 类描述——表示这个方法有可能抛出异常

 

通用注释

·@author 作者

·@version 版本

·@since  始于 例如，@since version 1.7.1

·@deprecated 不再使用的标记

·@see 引用 例如：@see com.horstmann.corejava.Employee#raiseSalary(double)

建立一个链接，到com.horstmann.corejava.Employee类的raiseSalary(double)方法的超链接。

 

注意：

1. 可以省略包名，甚至把包名和类名都省去，此时，连接将定位于当前包或当前类。
2. 一定要是使用#，而不要使用句号（.）分隔类名与方法名，或类名与变量名