@WebServlet 注释似乎会干扰 javadoc。有简单的解决方法吗？答案

【问题标题】：@WebServlet annotation seems to interfere with javadoc. Is there an easy workaround?@WebServlet 注释似乎会干扰 javadoc。有简单的解决方法吗？
【发布时间】：2014-10-19 00:46:51
【问题描述】：

我刚刚开始使用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 注释出现在类名上方。

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

编辑：我尝试在代码中重新定位注释，但没有效果。

【问题讨论】：

把javadoc移到注解上面怎么样？
糟糕。我应该提到我在我的帖子中尝试过。还是谢谢。
@ViscountRandom 这是一个讨厌的错误！ :-D

标签： java servlets annotations javadoc

【解决方案1】：

对我来说，它似乎有效，请参阅

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

}

生成

同时

@WebServlet

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

}

生成

我正在使用 Java 7。

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

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

}

会生成

【讨论】：

感谢您如此详细的回复。在检查了您的代码后，我意识到了问题的原因：我需要将 import javax.servlet.annotation.WebServlet; 语句和 @WebServlet(...) 语句与 javadoc 注释块分开（出于某种原因，我在尝试解决问题时将这两个语句移到了一起，这在早晨的寒冷光线下没有多大意义:)）。