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

【问题标题】：Should I use a "non-Javadoc" comment?我应该使用“非 Javadoc”注释吗？
【发布时间】：2011-09-14 08:39:24
【问题描述】：

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

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

其实我真的需要给这个方法加点注释。我该怎么办？

【问题讨论】：

【解决方案1】：

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

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

【讨论】：

【解决方案2】：

Eclipse 为您提供了一些东西，但您可以随意更改它。通过添加第二个星号将其更改为 javadoc 注释，使其在开头成为 /**，然后像使用其他 javadoc cmets 一样编写任何您想要的内容。 Eclipse 不会妨碍您，也不会坚持让您改回来——它只是为您提供一些样板文件供您使用。

【讨论】：