Javadoc

释义 Definition

Javadoc：Java 语言的文档注释规范与自动生成 API 文档的工具/系统。通常指用 /** ... */ 形式编写的注释，以及由此生成的 HTML 文档。（也常写作 JavaDoc）

发音 Pronunciation (IPA)

/ˈdʒɑːvəˌdɑk/

例句 Examples

I added Javadoc to the new method.
我给这个新方法补上了 Javadoc 注释。

Good Javadoc explains not only what the code does, but also its parameters, return value, and edge cases.
好的 Javadoc 不仅说明代码做什么，还会解释参数、返回值以及各种边界情况。

词源 Etymology

由 Java + doc/documentation（文档） 组合而来，最初用于指代 Java 官方提供的文档生成机制与工具链：从源码中的标准注释提取信息，生成可浏览的 API 参考文档。

相关词 Related Words

• Api
• Documentation
• Comment
• Annotation
• Sdk
• Javadoc Tool
• Docstring

文学/作品引用 Literary Works

• Effective Java（Joshua Bloch）中多处讨论编写清晰的 API 文档与注释实践，涉及 Javadoc 的使用习惯。
• Head First Java 中介绍 Java 基础与开发工具时会提到用 Javadoc 生成文档的做法。
• Oracle 官方文档 The Javadoc Tool / Java Platform, Standard Edition Documentation（技术文档作品）系统阐述了 Javadoc 的标签与生成流程。