java - java api文档上的"Field Summary"

标签 java javadoc

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

这个字段的常量和类有什么用?

谢谢。

最佳答案

生成的 Javadoc 页面的“字段摘要”用于总结类的(通常是公共(public)和 protected )字段,并提供指向页面下方更详细字段描述的链接。与方法一样,字段摘要部分中的文本由相关详细信息部分的第一句话组成。

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

关于java - java api文档上的"Field Summary",我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/4143461/

相关文章:

java - 自动为所有文件插入@since标签

java - JMenuBar 和项目数组 - 坏主意?

java - 我的按钮使我在 eclipse android : ActivityNotFoundException 中的项目崩溃

Java类常量池重复?

java - 使用 JRImageLoader.loadAwtImageFromBytes 方法加载图像时出现错误

javadoc - 类 Scaladoc 改进的 javadoc 格式?

java - 网页中的 GPS 位置

java - 如何 Javadoc 类的单个枚举

java - Eclipse 仅为某些方法生成 Javadoc

JavaDoc 覆盖