模块信息中的 Javadoc 注释

Question

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

Answer 1

一句话—​​—是的。例如，您可以看到 Java 9 的 Javadoc 如何具有模块级文档（包括provides、uses、的标签moduleGraph），然后列出其中的包及其文档。这些包又包含类及其文档。

作为一个快速示例，请查看jdk.jshell模块文档。

Answer 2

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

模块声明

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

来源：-标准 doclet 的文档注释规范

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

1. @index
2. @summary

然后module具体

3. @provides
4. @uses