如何用Java文档记录我的Java方法？

Question

我希望当我将鼠标悬停在一个方法上时,我能够看到我的文档,当我将鼠标放在Java的方法上时,该方法的功能我知道/***/是如何完成的但是:

1. 你如何解释Params代表什么？

2. 你如何创建一个新行,或者使一个单词变为粗体或斜体？

Answer 1

如果您使用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
 */

Answer 2

你如何解释Params代表什么？

使用@param标签:

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

你如何创建一个新行,或者使一个单词变为粗体或斜体？

使用标准的HTML,即<p></p>,<br/>,<strong>和<em>(或更少语义<b>和<i>)