如何在Netbean的文档窗口中创建帮助文档

时间:2015-09-15 16:25:48

标签: java javadoc netbeans-7

我想知道如何在Netbeans中创建一个java帮助文档。如下图所示。 对于每个内置函数和属性,都有一些注释(帮助文档)。但我想为我的函数或类创建自己的帮助文档。是否可以在netbeans中创建这种类型的文档。

enter image description here

任何答案都可以接受..

Regds ..

1 个答案:

答案 0 :(得分:0)

某些IDE可以自动从源代码中提取javadoc或直接从附加的javadoc中显示,并在弹出窗口中显示某些操作(IntelliJ IDEA上的ctrl + q)。

首先,您必须为您的元素(类,方法,字段等)编写javadoc,然后您可以在IDE的弹出窗口中看到此javadoc描述的元素以及其他javadoc。

IntelliJ IDEA中的示例:

类是在没有javadoc的情况下编写的。 IDE中javadoc的弹出窗口: enter image description here
enter image description here
没有文档,因为它没有写。

让我们为类和方法编写javadoc。现在显示弹出窗口的是什么? enter image description here
enter image description here
我认为NetBeans IDE必须是相同的。