java函数描述在eclipse代码建议中的工作原理

Question

当我们使用eclipse时，它为我们的java代码提供建议并显示描述，即一个小的弹出窗口，显示关于函数的描述。假设我正在创建一个java库，并且我需要在我的库中添加关于eclipse应该识别并显示为建议的函数的描述，那么我应该如何指定描述，即我需要使用什么类型或格式的注释来显示这些关于函数的描述。 任何人都可以为我提供解决上述问题的链接

Answer 1

你只需要提供javadoc

在方法开始之前，请提及以下注释：

/**
 ...
*/

你应该完蛋了

这里有几个链接可以帮助你

Javadoc Tutorial

How to write Javadoc