Как документировать мой метод в Java, как Java-документы?

Я хочу, чтобы при наведении указателя мыши на метод я мог бы видеть свою документацию о том, что нравится методу, когда я накладываю мышь на метод Java. Я знаю, что /** */как это делается, но:

Как вы объясните, что означает Params?
Как создать новую строку или сделать слово полужирным или курсивным?

Ответ 1

Если вы используете Eclipse как IDE, вам просто нужно создать комментарий с помощью

/**

и нажмите Enter, и он сгенерирует ваш код для вашего Javadoc, включая параметры, возвращаемые значения и т.д. Вам просто нужно указать описания.

То же самое относится к объявлениям классов (комментарий Javadoc всегда относится к следующему элементу)

Примечание:

Чтобы прикрепить документ к вашему методу, вам нужно указать имя метода в комментариях вверху.

Например

/**
 * create_instance
 * @param array of attributes for instance containing web, db, arrival_rate, response_time for instance 
 * respectively.
 * @return Instance object
 */

Ответ 2

Как вы объясните, что означает Params?

Использовать тег @param:

/**
 * @param paramName Explanation of the param
 */
public void foo(String paramName);

Как создать новую строку или сделать слово полужирным или курсивом?

Используйте стандартный HTML, т.е. ,  ,  и  (или менее семантический  и )