Should I use a "non-Javadoc" comment?

Question

I implemented my own method defined in an interface. However when I try to add Javadoc to this method Eclipse gave me a comment like this:

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

Actually, I really need to add some comment to this method. What should I do?

Answer 1

The idea of adding a non-javadoc comment here is that in the generated javadoc the comment from the inherited method will be copied, which might be enough - and better than if you had an empty /** */ comment. At the same time, you can use the link in the source code to look up the method. And as said by Ken, you can always change it.

If you want to include the interface's documentation, use {@inheritDoc} in your comment.

Answer 2

Eclipse gave you something, but you can feel free to change it. Change it into a javadoc comment by adding the second star to make it a /** at the beginning, then write whatever you want just like you do with the other javadoc comments. Eclipse won't get in your way or insist you change things back -- it's just giving you some boilerplate to work with.