Имеет ли "/ * (non-javadoc)" понятное значение? - PullRequest
28 голосов
/ 04 января 2011

Имеет ли значение /* (non-javadoc) помимо указания читателю исходного кода, что блок комментария намеренно не является комментарием Javadoc? В последнее время я видел много кода, который выглядит так:

/*
 * (non-javadoc)
 *
 * This method converts widgets to gizmos
 */
public Foo bar() {
   ...

Это установленное соглашение какого-то рода? Если так, что это означает (кроме очевидного буквального значения) и когда это используется?

Ответы [ 2 ]

19 голосов
/ 04 января 2011

Согласно информации , которую я смог найти , это было для исправления ошибки в более старых версиях инструмента JavaDoc (или, более вероятно, более старой версии обработки комментариев JavaDoc в Eclipse), которая не отображала правильную документацию для метода, который переопределяет метод родительского класса.

Как отметил Константин, шаблон переопределения Eclipse включает этот текст.

16 голосов
/ 04 января 2011

Он не имеет установленного значения, кроме того, что является комментарием. Форматирование является результатом общих шаблонов форматирования кода Eclipse, что объясняет его общность.

...