“字段摘要"在Java api doc上 [英] "Field Summary" on java api doc

问题描述

当我阅读Java的API文档时，会看到一个名为字段摘要"的字段. 这部分是做什么用的?.

when I read the API documentation of Java I see a field with the name "Field Summary". What this Part is used for?.

在此字段中，常量和类的用途是什么?

What is the use of the constant and classes in this field?.

谢谢.

推荐答案

生成的Javadoc页面的字段摘要"用于汇总类的(通常是公共的和受保护的)字段，并提供指向更详细说明的链接页面下方的字段.与方法一样，字段摘要部分中的文本由关联的详细信息部分中的第一句话组成.

The "Field Summary" of a generated Javadoc page is for summarizing the (typically public and protected) fields of a class, and providing links to the more detailed descriptions of the fields further down the page. Just as with methods, the text in the summary section for fields consists of the first sentence from the associated detail section.

由于Java已经发展了良好的实践，这意味着可变字段通常是私有的，因此通常只在其中记录常量(例如，

Since good practice has evolved for Java that means that mutable fields are usually private, it is usually just constants that are documented there (e.g., java.lang.Double has a few) though there are some classes that have modifiable fields (e.g., javax.xml.ws.Holder has one, and the class is sufficiently simple that this isn't a problem).

这篇关于“字段摘要"在Java api doc上的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！