Генерация Javadoc

Question

Задание, над которым я работаю, запрашивает:

Разумная документация по встроенному коду, предоставляющая сгенерированную Javadoc документацию с описаниями методов, описаниями параметров и возвращаемых значений.

Разве это не просто / **?Или это будет версия, сгенерированная затмением?

Answer 1

Они просто просят правильно прокомментировать код таким образом, чтобы они могли впоследствии извлечь документацию с помощью инструмента javadoc. Вы должны следовать всем рекомендациям Javadoc , и, конечно, если вам нужны дополнительные кредиты, запустите этап документации вашей сборки, чтобы фактически сгенерировать документы. Я уверен, что им это понравится.

Answer 2

«Документация, сгенерированная Javadoc» будет HTML-документацией, сгенерированной из комментариев /** в коде. Я не знаю, есть ли у Eclipse функция для этого, но обычно это делается с помощью инструмента командной строки javadoc, поставляемого с JDK.