我应该使用“非Javadoc”注释吗？

java javadoc

2022-09-02 10:07:13

我实现了在接口中定义自己的方法。但是，当我尝试将Javadoc添加到此方法时，Eclipse给了我这样的评论：

/* (non-Javadoc)
 * @see javax.servlet.ServletContextListener#contextInitialized(javax.servlet.ServletContextEvent)
 */

实际上，我真的需要为此方法添加一些注释。我该怎么办？

答案 1

在这里添加非javadoc注释的想法是，在生成的javadoc中，将复制来自继承方法的注释，这可能就足够了 - 并且比有空注释更好。同时，您可以使用源代码中的链接来查找该方法。正如Ken所说，你总是可以改变它。/** */

如果要包含界面的文档，请在注释中使用。{@inheritDoc}

答案 2

Eclipse给了你一些东西，但你可以随时改变它。通过添加第二个星号将其更改为javadoc注释，使其在开头成为a，然后编写您想要的任何内容，就像您处理其他javadoc注释一样。Eclipse不会妨碍你，也不会坚持要你把事情改回来——它只是给你一些样板来使用。/**