什么是Javadoc摘要片段？

我正努力坚持你的建议

该节规定如下：

每个Javadoc块都以一个简短的摘要片段开始。这个片段非常重要：它是文本中唯一出现在某些上下文（如类和方法索引）中的部分

这是一个片段——一个名词短语或动词短语，而不是一个完整的句子。它不是以{@code Foo}为…开头，或者这个方法返回…，也不是像保存记录那样形成完整的命令句。。然而，片段被大写并加上标点符号，就好像它是一个完整的句子一样

以下是我想知道的：

• 什么是摘要片段？据说每个Javadoc块都是以它开头的，它是文本，但是有没有更多的文档可以让我更好地理解它呢
• 为什么摘要片段非常重要？据说它出现在类和方法索引中，但我不确定我是否理解这意味着什么，或者为什么它很重要。我最好的猜测是，这是一种标记类及其成员的方法，这样可以更容易地搜索它们
• 我在哪里可以找到并阅读摘要片段？我正在使用IntelliJ IDEA，所以我知道如何通过检查访问代码中类和成员的Javadoc，但是有没有办法列出所有可用的摘要片段

---

您的前两个问题已得到回答：
• 摘要片段究竟是什么
每个文档注释的第一句应为摘要句，包含API项的简明但完整的描述。这意味着每个成员、类、接口或包描述的第一句话
• 为什么摘要片段非常重要
Javadoc工具将第一句话复制到适当的成员、类/接口或包摘要中。这使得写清晰、信息量大、能够独立表达的初始句子非常重要
• 在哪里可以找到并阅读摘要片段
  • 是一个表，由三列（在某些版本中，组合为两列）“修饰符和类型”、“方法”和“说明”组成。它简要描述了方法的功能，即API；选择HashMap仅仅是为了演示示例
  • 是一个网页，索引特定Java构建的整个API

---

“方法摘要”和“索引”都是Java文档的一部分。
请查看“方法摘要”部分。这是最右边一栏中的简要方法描述。感谢您提供的信息，这将解释在何处使用摘要-在Javadoc摘要部分中，为读者提供清晰简洁的信息。然而，我仍然对什么是方法和类索引感兴趣。您链接的文档说“Javadoc自动将其放在方法摘要表（和索引）中。”，索引指的是什么？@Matthew查看更新的答案。