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

【问题标题】：How to document my method in Java like Java docs?如何像 Java 文档一样用 Java 记录我的方法？
【发布时间】：2012-08-01 16:41:28
【问题描述】：

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

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

【问题讨论】：

请阅读docs

标签： java documentation javadoc

【解决方案1】：

你如何解释 Params 代表什么？

使用@param标签：

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

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

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

【讨论】：

【解决方案2】：

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

【讨论】：

事实上，非常常用的功能
你可以为 intelliJ 做同样的事情
您不需要在注释顶部指定方法名称。无论有没有它都可以工作。