JavaBean文档

时间:2015-02-16 05:04:49

标签: java javabeans javadoc

我一直在搞乱用Java制作自定义控件,我想知道添加文档的正确方法是什么。我有很多带有getter和setter的私有变量,每个变量都有自己的PROP_ [variable name]变量。当你将鼠标悬停在变量上时,我特意寻找记录在Netbeans编辑器中显示的方法(就像使用JLabel一样,如果将鼠标悬停在文本属性上,则会显示“定义此组件的单行文本”将显示“)。

有什么想法吗?

编辑:我已经为javadoc尝试了多个位置,但它们似乎都没有工作(是的,我正在生成javadoc)。我把文档放在私有字段,PROP_ [变量名称]字段,以及getter和setter,但它们都没有工作。我也试过查看BeanInfo文件,那里也没有任何与javadoc有关的内容。

2 个答案:

答案 0 :(得分:0)

这很简单:在您要为其添加文档的项目之上添加评论(/** ... */)。完整的例子:

/**
 *Defines the single line of text this component will display
 */
public class JLabel{
   ...
}

当鼠标悬停在项目上时,将显示此文本。有关文档的完整图片,请参阅此article

答案 1 :(得分:0)

没关系,我找到了。在生成的BeanInfo类中,您可以将“简短描述代码”属性设置为字符串,这就是显示的内容。实际上代码文件本身没有javadoc。