将鼠标悬停在 Function/Class 上时显示信息
Showing information when hovering over Function/Class
我正在开发一个API,我需要向用户提供一些信息。
在我的具体情况下,我在下一个版本中将 Class 标记为已弃用(我希望它可用,但让用户知道它会在不久的将来被删除)。
我想告诉用户这个功能在he/she悬停在它上面时已被弃用,一个例子(这显示了有关如何使用该功能的信息,我的有点不同,我只是想展示一个带有信息的小消息):
我的案例
我想在将鼠标悬停在 class 上时显示消息 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....
}
如何实现?
(我希望我解释得很好,我的英语还不够完美,如果您发现任何 spelling/grammar 错误,请随时编辑)。
谢谢大家
更新:
这是我在 class 中看到的:
我发现了问题。这比我想象的要简单得多,而且都是我的错,不是错误。
解法:
编译 .jar 文件和 select 创建的 JavaDoc 时,确保 select 选择 Export all output folders for checked projects
选项。如果您没有特别指定,Eclipse 将不会添加文档文件。
我正在开发一个API,我需要向用户提供一些信息。
在我的具体情况下,我在下一个版本中将 Class 标记为已弃用(我希望它可用,但让用户知道它会在不久的将来被删除)。
我想告诉用户这个功能在he/she悬停在它上面时已被弃用,一个例子(这显示了有关如何使用该功能的信息,我的有点不同,我只是想展示一个带有信息的小消息):
我的案例
我想在将鼠标悬停在 class 上时显示消息 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....
}
如何实现?
(我希望我解释得很好,我的英语还不够完美,如果您发现任何 spelling/grammar 错误,请随时编辑)。
谢谢大家
更新:
这是我在 class 中看到的:
我发现了问题。这比我想象的要简单得多,而且都是我的错,不是错误。
解法:
编译 .jar 文件和 select 创建的 JavaDoc 时,确保 select 选择 Export all output folders for checked projects
选项。如果您没有特别指定,Eclipse 将不会添加文档文件。