我刚刚开始使用javadoc
工具为包含servlet类的包创建文档。除servlet之外,每个类都按预期方式工作,该servlet中未出现描述。
经过反复试验,我将原因缩小为@WebServlet
注释,该注释用于声明Tomcat的servlet。如果可以避免,我宁愿不删除此注释。我可以使用一种简单的解决方法吗?
这是我的代码的相关部分:
import javax.servlet.annotation.WebServlet;
@WebServlet("/MyServlet")
/**
* MyServlet description
*
* @author ViscountRandom
* @since 2014-08-26
*/
public class MyServlet extends HttpServlet {
...
可以在here上看到生成的
javadoc
页面(注意,缺少描述,并且@WebServlet
批注出现在类名的上方)。在此先感谢您提供的任何帮助。
编辑:我试图在我的代码中重新放置注释,但这没有任何效果。
最佳答案
对我来说,似乎很有效,请参阅
/**
* 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 {
}
这将产生