Java文档
JavaBean documentation
我一直在搞乱在 Java 中制作自定义控件,我想知道添加文档的正确方法是什么。我有很多带有 getter 和 setter 的私有变量,每个变量都有自己的 PROP_[变量名] 变量。我正在专门寻找记录它们的方法,当您将鼠标悬停在变量上时,它们会显示在 Netbeans 编辑器中(就像使用 JLabel,如果您将鼠标悬停在文本 属性 上,它显示为 "Defines the single line of text this component will display" ).
有什么想法吗?
编辑:我已经为 javadoc 尝试了多个位置,其中 none 似乎有效(是的,我正在生成 javadoc)。我已经将文档放在私有字段、PROP_[变量名] 字段以及 getter 和 setter 上,其中 none 有效。我也试过查看 BeanInfo 文件,那里也没有与 javadoc 相关的内容。
这很简单:在要为其添加文档的项目顶部添加评论 (/**
... */
)。完整示例:
/**
*Defines the single line of text this component will display
*/
public class JLabel{
...
}
当您的鼠标悬停在该项目上时,将显示此文本。有关文档的完整图片,请参阅此 article。
没关系,我找到了。在生成的 BeanInfo class 中,您可以将 "short description code" 属性 设置为字符串,这就是显示的内容。代码文件本身实际上没有 javadoc。
我一直在搞乱在 Java 中制作自定义控件,我想知道添加文档的正确方法是什么。我有很多带有 getter 和 setter 的私有变量,每个变量都有自己的 PROP_[变量名] 变量。我正在专门寻找记录它们的方法,当您将鼠标悬停在变量上时,它们会显示在 Netbeans 编辑器中(就像使用 JLabel,如果您将鼠标悬停在文本 属性 上,它显示为 "Defines the single line of text this component will display" ).
有什么想法吗?
编辑:我已经为 javadoc 尝试了多个位置,其中 none 似乎有效(是的,我正在生成 javadoc)。我已经将文档放在私有字段、PROP_[变量名] 字段以及 getter 和 setter 上,其中 none 有效。我也试过查看 BeanInfo 文件,那里也没有与 javadoc 相关的内容。
这很简单:在要为其添加文档的项目顶部添加评论 (/**
... */
)。完整示例:
/**
*Defines the single line of text this component will display
*/
public class JLabel{
...
}
当您的鼠标悬停在该项目上时,将显示此文本。有关文档的完整图片,请参阅此 article。
没关系,我找到了。在生成的 BeanInfo class 中,您可以将 "short description code" 属性 设置为字符串,这就是显示的内容。代码文件本身实际上没有 javadoc。