模块信息中的Javadoc注释

时间:2018-12-28 11:02:55

标签: java javadoc java-module module-info

除了先前存在的AppDelegate文件之外,Java 9模块功能还添加(更高级)AppDelegate文件。 NSObject(源代码)文件是否可以包含JavaDoc工具将提取并作为模块级文档(有用)呈现的标记注释?

2 个答案:

答案 0 :(得分:4)

总而言之-是的。例如,您可以查看Java 9的Javadoc如何具有模块级文档,然后在文档中列出其中的软件包及其文档。这些软件包依次包含带有其文档的类。

作为一个简单的示例,请查看jdk.shell module documentation

答案 1 :(得分:2)

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

模块声明

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

来源:-Documentation Comment Specification for the Standard doclet

其中,您可能会对新引入的标签感兴趣:

  1. @index
  2. @summary

然后是module特定的

  1. @provides
  2. @uses