Я реализовал свой собственный метод, определенный в интерфейсе. Однако, когда я пытаюсь добавить Javadoc к этому методу, Eclipse дал мне такой комментарий:
/* (non-Javadoc)
* @see javax.servlet.ServletContextListener#contextInitialized(javax.servlet.ServletContextEvent)
*/
На самом деле, мне действительно нужно добавить комментарий к этому методу. Что мне делать?
Идея добавления комментария, отличного от javadoc, заключается в том, что в сгенерированном javadoc будет скопирован комментарий от унаследованного метода, которого может быть достаточно - и лучше, чем если бы у вас был пустой комментарий /** */. В то же время вы можете использовать ссылку в исходном коде для поиска метода. И, как сказал Кен, вы всегда можете изменить его.
Если вы хотите включить документацию по интерфейсу, используйте {@inheritDoc} в своем комментарии.
Eclipse дал вам что-то, но вы можете смело менять его. Измените его на комментарий javadoc, добавив вторую звезду, чтобы сделать его /** в начале, а затем напишите все, что хотите, как и вы, с другими комментариями javadoc. Eclipse не будет мешать вам или настаивать на том, чтобы вы изменили ситуацию - это просто дает вам несколько шаблонов для работы.