java 改进_Java 9 改进 Javadoc

Ja va 9改进 Ja vadoc

说到Ja va文档生成，Ja vadoc工具绝对是开发者的老朋友了。在Ja va 9中，这位老朋友迎来了一项重要升级：其生成的文档输出，现在完全符合兼容HTML5标准。这意味着什么？简单来说，就是生成的文档页面能更好地适配现代浏览器，结构更清晰，也更具未来兼容性。

Ja va 9之前的旧版本文档

为了直观地对比，我们先来看看旧版本是如何工作的。假设我们有一个简单的Ja va源文件，路径是 C:/JA VA/Tester.ja va，内容如下：

实例

/**
 * @author MahKumar
 * @version 0.1
 */
public class Tester {
    /**
     * Default method to be run to print
     * 
Hello world
     * @param args command line arguments
     */
    public static void main(String[] args) {
        System.out.println("Hello World");
    }
}

接下来，我们使用JDK 7环境下的ja vadoc命令来为它生成文档：

C:\JA VA> ja vadoc -d C:/JA VA Tester.ja va
Loading source file tester.ja va...
Constructing Ja vadoc information...
Standard Doclet version 1.7.0_21
Building tree for all the packages and classes...
Generating C:\JA VA\Tester.html...
Generating C:\JA VA\package-frame.html...
Generating C:\JA VA\package-summary.html...
Generating C:\JA VA\package-tree.html...
Generating C:\JA VA\constant-values.html...
Building index for all the packages and classes...
Generating C:\JA VA\overview-tree.html...
Generating C:\JA VA\index-all.html...
Generating C:\JA VA\deprecated-list.html...
Building index for all classes...
Generating C:\JA VA\allclasses-frame.html...
Generating C:\JA VA\allclasses-noframe.html...
Generating C:\JA VA\index.html...
Generating C:\JA VA\help-doc.html...

命令执行完毕后，一系列HTML文档就会在C:/JA VA目录下生成。其生成的索引页面效果，大致如下图所示：

Ja va 9生成的文档兼容HTML5标准

那么，Ja va 9带来了什么变化呢？关键就在于一个新的命令行参数：-html5。使用JDK 9的ja vadoc时，只要加上这个参数，就能强制工具生成完全支持HTML5标准的文档。

我们同样对那个Tester.ja va文件进行操作，这次使用JDK 9的命令：

C:\JA VA> ja vadoc -d C:/JA VA -html5 Tester.ja va
Loading source file Tester.ja va...
Constructing Ja vadoc information...
Standard Doclet version 9.0.1
Building tree for all the packages and classes...
Generating C:\JA VA\Tester.html...
Generating C:\JA VA\package-frame.html...
Generating C:\JA VA\package-summary.html...
Generating C:\JA VA\package-tree.html...
Generating C:\JA VA\constant-values.html...
Building index for all the packages and classes...
Generating C:\JA VA\overview-tree.html...
Generating C:\JA VA\index-all.html...
Generating C:\JA VA\deprecated-list.html...
Building index for all classes...
Generating C:\JA VA\allclasses-frame.html...
Generating C:\JA VA\allclasses-frame.html...
Generating C:\JA VA\allclasses-noframe.html...
Generating C:\JA VA\allclasses-noframe.html...
Generating C:\JA VA\index.html...
Generating C:\JA VA\help-doc.html...

从输出日志可以看到，核心流程与之前类似，但底层生成的HTML代码已经遵循了HTML5规范。执行上述命令后，在C:/JA VA目录下生成的文档页面，其外观可能看似变化不大，但内在的代码结构已经更新，如下图所示：

这个改进虽然看似细微，但对于确保生成的文档能在当前及未来的浏览器中稳定、正确地显示，却至关重要。它标志着Ja va工具链正与现代Web标准保持同步。