自开始以来, Javadoc输出基本上是静态HTML,具有导航链接和外观的简单样式表样式。 Java SE 7很长时间以来就看到Javadoc输出默认外观的第一个重大变化 ,现在看来JDK 8将在生成的Javadoc输出上引入新的变化。 在本文中,我将通过JDK 8的javadoc工具似乎可以使用的方法类型,对Javadoc输出中的方法进行更动态的过滤。
以下两个屏幕快照比较了Calendar类的JDK 7和JDK 8版本的默认Javadoc输出(根据其各种方法类型选择)。
尽管JDK 8的Javadoc输出具有与Java 7 Javadoc文档相同的总体样式(包括用于“构造函数”,“字段”,“方法”等的橙色“选项卡”),但JDK 8生成的文档中的方法具有多种样式方法列表上方的橙色选项卡,使读者可以单击相应的选项卡以查看方法的适当子集。 选项卡的名称与您想使用的名称一样简单,使用“所有方法”(类中的所有方法),“ 静态方法 ”(类级方法),“ 实例方法 ”(对象级方法)之类的名称),“ 抽象方法 ”(没有实现的方法)和“ 具体方法 ”(已实现的方法)。
下一个系列的屏幕快照演示了如何单击这些选项卡来调用嵌入式JavaScript代码,该代码在位于生成的Javadoc目录结构的根级别上的script.js
文件中调用适当的功能。
这是JDK 8中Javadoc的次要功能,但仍然有些方便。我经常在Javadoc的方法中查找具有混合方法类型的类,以找到适合特定类型的方法。 现在,无需扫描诸如“ static”或“ abstract”之类的关键字,也无需扫描缺少这些单词的关键字,我只需使用这些“选项卡”来过滤想要在给定类中看到的方法类型。
翻译自: https://www.javacodegeeks.com/2013/04/jdk-8-javadoc-tweaked-for-methods-listings.html