我应该使用“非Javadoc”评论吗？

Question

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

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

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

Answer 1

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

如果您想要包含界面的文档，请在评论中使用{@inheritDoc}。

Answer 2

Eclipse给了你一些东西，但你可以随意改变它。通过添加第二个星形将其更改为javadoc注释，使其在开头变为/**，然后像对待其他javadoc注释一样编写任何您想要的内容。 Eclipse不会妨碍你或坚持让你改变一些东西 - 它只是给你一些样板来处理。