17

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

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

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

4

2 回答 2

32

在大多数主流 IDE 中，例如 IntelliJ 的 IDEA、Apache Netbeans 或 Eclipse；你可以输入

/**

然后回车，它会为你的方法生成Javadoc，包括参数、返回值等。你只需要输入描述。

这同样适用于类声明（Javadoc 注释始终与以下元素相关）

例如

/**
 * create_instance
 * @param array of attributes for instance containing web, db, arrival_rate, response_time for instance 
 * respectively.
 * @return Instance object
 */
于 2012-08-01T17:01:25.797 回答
24

你如何解释 Params 代表什么？

使用@param标签：

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

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

使用标准 HTML，即<p></p>, <br/>, <strong>and <em>（或语义较少的<b>and <i>）

于 2012-08-01T16:44:01.407 回答