关于java api doc的“字段摘要”

时间:2010-11-10 10:29:53

标签: java javadoc

当我阅读Java的API文档时,我看到一个名为“Field Summary”的字段。 这部分用于什么?。

此字段中常量和类的用法是什么?。

感谢。

1 个答案:

答案 0 :(得分:3)

生成的Javadoc页面的“字段摘要”用于汇总类的(通常是公共和受保护的)字段,并提供指向页面下方字段的更详细描述的链接。与方法一样,字段摘要部分中的文本包含相关详细信息部分中的第一个句子。

由于Java的良好实践已经发展,这意味着可变字段通常是私有的,它通常只是那里记录的常量(例如,java.lang.Double有一些)虽然有一些类具有可修改的字段(例如,javax.xml.ws.Holder有一个,而且这个类非常简单,这不是问题。)