1.前言
我原本以为注释没什么好写的,不就是“//”和“/**/”么。直到我一次又一次的遇到下面类似的代码,我才意识到自己又天真了一回。
@WebServlet(name="MyServlet",urlPatterns={"/my"})
public class MyServlet implements Servlet
{
...
}
反正我没看懂!接下来就进入正题了。这里因为注释符号在博客编辑器中容易出现格式问题,所以在代码里进行说明。
2.文档注释
(1)注释的插入
注释以/**开始,并以*/结束每个/**...*/文档注释包含标记以及之后紧跟着的自由格式文本。标记以@开始,如@since或@param
(2)类注释
类注释必须放在import语句之后,类定义之前。下面是一个类注释的例子
/**
A{@code Card}object represents a playing card...
*/
public class Card
{
...
}
(3)方法注释
每一个方法注释必须放在所描述的方法之前。处理通用标记之外,还可以使用下面的标记
@param variable description
这个标记将给当前方法的“parameters”(参数)部分添加一个条目。这个描述可以占据多行,并且可以使用HTML标记。一个方法的所有@param标记必须放在一起。
@return description
这个标记将给当前方法添加“returns”(返回)部分。这个描述可以跨多行,并且可以只用HTML标记。
@throws class description
这个标记将添加一个注释,表示这个方法有可能抛出异常。
下面是一个方法注释的示例:
/**
Raises the salary of an employee
@param byPercent the percentage by which to raise the salary
@return the amount of the raise
*/
public double raiseSalary(double byPersent)
{
double raise=salary*byPercent/100;
salary+=raise;
return raise;
}
(4)字段注释
只需要对公共字段(通常指的是静态常量)建立文档。例如,
/**
The "Hearts" card suit
*/
public static final int HEARTS=1;
(5)通用注释
标记@since text会建立一个“since”(始于)条目。text可以是引入这个特性的版本的任何描述。如,@since 1.7.1
下面的标记可以用在类文档注释中。
@author name
这个标记将产生一个“author”条目。可以使用多个@author标记,每个@author标记对应一个作者。
@version text
这个标记将产生一个“version”条目。这里的文本可以是对当前版本的任何描述。
通过@see和@link标记,可以使用超链接
到现在还没有解决开始的那个问题,那是一种注释机制:注解。
因为注解的接口很多,不太方便一一列举出来,一般是需要的时候查阅文档就行,这里提供一个参考链接。
Java注解