Java基础（四）注释

　　1.类注释

　　类注释必须放在import语句之后，类定义之前。eclipse中使用Shift + Alt + J快捷键添加类注释。

　　2.方法注释

　　每一个方法注释必须放在所描述的方法之前。除了通用标记之外，还可以使用下面的标记：

• @param：对当前方法的“param”（参数）部分添加一个条目。一个方法的所有@param标记必须放在一起。
• @return：对当前方法添加“return”（返回部分）
• @throws：对当前方法添加有可能抛出“异常”的标记

　　例如：

/**   
* Raise the salary of an employee
* @param byPercent the percentage by which to raise the salary(e.g.10 means 10%)
* @return the amount of the raise
*/
public returnraiseSalary(double byPercent)
{
   double raise = salary * byPercent / 100;
   salary += raise;
}

　　3.域注释

　　只需要对公有域（通常指的是静态常量）进行注释，例如：

/**
* The "Hearts" card suit
*/
public static final int HEARTS = 1;

　　4.通用注释

• @author姓名，标记一个作者条目。可以有多个@author标记，每个标记对应着一个作者
• @version文本，标记一个版本条目。
• @since文本，标记一个“since”（始于）条目，说明对引入特性的版本描述，例如@since version 1.7.1
• @deprecated文本，对类、方法或变量添加一个不再使用的注释，并给出取代建议。例如：@deprecated Use <code> setVisible(true) </code> instead
• @see引用，标记一个超链接。可以用到类中，也可以用到方法中。