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

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

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

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

15
documentation java javadoc

2 ответов

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

/**

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

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

Примечание:

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

например

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

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

использовать @param tag:

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

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

используйте стандартный HTML, т. е. <p></p>, <br/>, <strong> и <em> (или менее семантическим <b> и <i>)

22