模块信息中的 Javadoc 注释

Question

Java 9 模块功能添加了（更高级别的）module-info 文件以及之前存在的 package-info 文件。 module-info.java（源代码）文件是否可以包含 JavaDoc 工具将提取并作为模块级文档（有用地）呈现的标记注释？

Answer 1

一句话-是的。例如，您可以看到 Java 9 的 Javadoc 如何具有模块级文档，然后列出其中的包及其文档。这些软件包又包含类及其文档。

举个简单的例子，查看 jdk.shell module documentation。

Answer 2

是的。模块声明支持的标签是：

模块声明

{@author}, {@deprecated}, {@provides}, {@see}, {@since}, {@serialField}, {@uses}, {@version}
{@code}, {@docRoot}, {@index}, {@link}, {@linkplain}, {@literal}, {@summary}

来源:- Documentation Comment Specification for the Standard doclet

其中，您可能进一步感兴趣的新引入标签是：

然后module具体

模块信息中的 Javadoc 注释

Javadoc comments in module-info

java

javadoc

java-module

module-info