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

java documentation javadoc

2022-09-02 23:03:41

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

你如何解释Params代表什么？
如何创建新行，或将单词设置为粗体或斜体？

答案 1

在大多数主要的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
 */

答案 2

你如何解释Params代表什么？

使用标签：@param

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

如何创建新行，或将单词设置为粗体或斜体？

使用标准 HTML，即、和（或较少的语义和 )