Трябва ли да използвам коментар, който не е Javadoc?

Приложих собствен метод, дефиниран в интерфейс. Въпреки това, когато се опитвам да добавя Javadoc към този метод, Eclipse ми даде коментар като този:

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

Всъщност наистина трябва да добавя коментар към този метод. Какво трябва да направя?


java javadoc
person Sawyer    schedule 14.06.2011    source източник
comment
Имате ли нужда от интерфейс? Ако прилагате методи (предполагам публични методи), може да искате да използвате абстрактен клас?   -  person Terrell Plotzki    schedule 14.06.2011
comment
Тясно свързано: stackoverflow .com/questions/4597329/   -  person Ciro Santilli 新疆再教育营六四事件ۍ    schedule 20.02.2015

Отговори (2)


arrow_upward
14
arrow_downward

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

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

person Paŭlo Ebermann    schedule 14.06.2011

arrow_upward
12
arrow_downward

Eclipse ви даде нещо, но можете да се чувствате свободни да го промените. Променете го в коментар на javadoc, като добавите втората звезда, за да стане /** в началото, след което напишете каквото искате, точно както правите с другите коментари на javadoc. Eclipse няма да ви пречи или да настоява да промените нещата обратно – той просто ви дава някакъв шаблон, с който да работите.

person Ken Bloom    schedule 14.06.2011
comment
IMO, тази конкретна шаблонна плоча е пълна загуба на пространство ... въздишка. - person Stephen C; 14.06.2011