Должен ли я использовать комментарий «не Javadoc»?

Question

Я реализовал свой собственный метод, определенный в интерфейсе.Однако когда я пытаюсь добавить Javadoc к этому методу, Eclipse дал мне такой комментарий:

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

На самом деле мне действительно нужно добавить какой-то комментарий к этому методу.Что мне делать?

Answer 1

Идея добавления комментария без javadoc заключается в том, что в сгенерированный javadoc будет скопирован комментарий от унаследованного метода, что может быть достаточно - и лучше, чем если бы у вас был пустой комментарий /** */.В то же время вы можете использовать ссылку в исходном коде для поиска метода.И, как сказал Кен, вы всегда можете изменить его.

Если вы хотите включить документацию интерфейса, используйте {@inheritDoc} в своем комментарии.

Answer 2

Затмение дало вам что-то, но вы можете смело менять это.Измените его на комментарий Javadoc, добавив вторую звездочку, чтобы в начале он стал /**, затем напишите все, что вы хотите, так же, как вы делаете с другими комментариями Javadoc.Eclipse не будет мешать вам и не будет настаивать на том, чтобы вы что-то изменили - он просто дает вам пример для работы.