@tag

@tag标签是wrdoclet中一个非常重要的概念。开发人员可以对一个接口打多个标签,通过标签对服务接口的使用场景进行高度概括。方便接口文档的使用人员快速找到需要使用的接口。比如,开发人员可以对密码验证接口打上"安全"、"用户登录"、"密码"三个标签。

@tag是自定义的taglet。使用时只要在接口函数的注释中加上“@tag xxx”即可。

/**
 * @tag 安全,用户登录,密码
 * @param name 用户名
 * @param password 密码
 * @return 登录结果
 */
public int verifyPassword(
        @WebParam(name = "username", partName = "stupidPartName") String name,
        @XmlElement(required=true) String password);

如果某个类中的所有接口都需要打上相同的标签,可以在类的注释中加上@tag。比如:

/**
 * @tag 安全
 */
@WebService
public interface SecurityService {
...
}

在需要打多个标签时,可以用逗号或者分号(中英文皆可)分隔;也可以分多行,比如下面的例子。

/**
 * @tag 用户管理
 * @tag 用户
 * @param name 名字
 * @param password 密码
 * @return
 */
public int addUser(
        @WebParam(name = "username", partName = "stupidPartName") String name,
        @XmlElement(required=true) String password);

如果接口注释中没有使用任何标签,那么默认使用接口所在类名作为标签。

results matching ""

    No results matching ""