将鼠标悬停在“函数/类”上时显示信息

时间:2016-10-19 11:10:54

标签: java function deprecated

我正在开发API,我需要向用户提供一些信息。

在我的特定情况下,我在下一个版本中将一个Class标记为已弃用(我希望它可用,但让用户知道它将在不久的将来被删除)。

我想告诉用户当这个函数悬停在它上面时这个函数已被弃用了,一个例子(这显示了有关如何使用该函数的信息,我的有点不同,我只想用信息显示一条消息):

Example with DateFormat.format(Date date)

我的案例

我希望在将鼠标悬停在课程上时显示消息As of release 0.4.0, replaced by WhateverClass

我在我的项目中尝试过这个:(显然没有用,如果有的话,我不会在这里)

/**
 * @deprecated  As of release 0.4.0, replaced by {@see main.chart.FXPieChart}
 */
@Deprecated
public class PieChart extends JPanel {
    //Whatever....
}

我怎样才能实现它?

(我希望我能很好地解释一切,我的英语远非完美,如果您发现任何拼写/语法错误,请随时编辑。)

谢谢大家。

更新

这是我在班上看到的:

Hovering over PieChart (My Class)

1 个答案:

答案 0 :(得分:0)

我发现了问题。它比我想象的要简单得多,而且都是我的错,而不是错误。

<强>解决方案:

编译.jar文件并选择创建的JavaDoc时,请确保选择Export all output folders for checked projects选项。如果您没有特别说明,Eclipse不会添加文档文件。