@WebServlet注释似乎干扰了javadoc。有一个简单的解决方法吗?

时间:2014-08-25 19:40:14

标签: java servlets annotations javadoc

我刚开始使用javadoc工具为包含servlet类的包创建文档。除了没有出现描述的servlet之外,它正如预期的那样工作。

在反复试验之后,我将原因缩小到我用来为Tomcat声明servlet的@WebServlet注释。如果可以避免,我宁愿不删除这个注释。我可以使用一个简单的解决方法吗?

这是我的代码的相关部分:

import javax.servlet.annotation.WebServlet;
@WebServlet("/MyServlet")

/**
* MyServlet description
*
* @author   ViscountRandom
* @since    2014-08-26
*/
public class MyServlet extends HttpServlet {
...

可以看到生成的javadoc页面here(请注意,缺少说明,类名称上方会显示@WebServlet注释。)

提前感谢您提供的任何帮助。

编辑:我已尝试在我的代码中重新定位注释,但这没有效果。

1 个答案:

答案 0 :(得分:0)

对我而言,似乎有效,见

/**
 * My javadoc
 * <br>25/08/2014
 */
@WebServlet
public class MyServlet {

}

产生

enter image description here

,而

@WebServlet

/**
 * My javadoc
 * <br>25/08/2014
 */
public class MyServlet {

}

产生

enter image description here

我使用的是Java 7.

如果您只是希望您的javadoc位于源代码中的方法声明之上,您仍然可以尝试

/**
 * My javadoc
 * <br>25/08/2014
 */
@WebServlet public class MyServlet {

}

将生成

enter image description here