Java 9 - Javadoc改进

时间:2020-02-23 14:34:55  来源:igfitidea点击:

Java升级了它的 Javadoc为了更好的用户互动和用户体验。
它包括简化的搜索,HTML生成器,DOCLET API等。

什么是javadoc

Javadoc是一个像这样的工具 javac和一部分 JDK
它用于生成Java源代码HTML文档。
如果我们访问了Oracle,我们将看到JavaDoc生成的Java文档。
升级的javadoc具有以下函数。

简化的doclet api

在Java 9,老 Doclet API已被新的简化API替换。
虽然仍然支持现有的API,但我们可以使用新的DOCLET API。

支持HTML5.

它支持HTML5以获取更好的用户接口和工具。
所以新的 Javadoc是根据 HTML5版本。

改进搜索

javadoc提供了一个新的 search box查找类,包,方法。
它在片刻内提供更好的建议和准确的搜索。

支持模块系统

它有助于基于新的Java平台模块系统生成文档。
让我们举个例子。

如何从Java源文件创建HTML javadoc。

让我们创建一个示例来从Java源文件生成新HTML5文档。
其中我们创建了一个包含一些方法的计算类。

package com.theitroad;
/**
* It provides methods to compute basic arithmetic operations.
* @author Irfan
* @version 1.0
* 
*/
public class Calculate {
 
/**
* Returns sum of two integer numbers
*
* @param a and b of integer type
*/
public int add(int a, int b){
    return(a+b);
}
/**
* Returns subtraction of two integer numbers
*
* @param a and b of integer type
*/
public int sub(int a, int b){
    return(a-b);
}
/**
* Returns multiply of two integer numbers
*
* @param a and b of integer type
*/
public long mult(int a, int b){
    return(a*b);
}
/**
* Returns division of two integer numbers
* 
* @param a and b of integer type
*/
 
public float div(int a, int b){
    return(a/b);
}
}

运行javadoc命令

要创建javadoc,请使用以下命令。
执行它使用 cmd或者 terminal到达Java文件位置后。

javadoc -d . -html5 Calculate.java

它将生成填充到正在处理指令的控制台的一些消息。

Loading source file Calculate.java...
Constructing Javadoc information...
Standard Doclet version 11.0.8
Building tree for all the packages and classes...
Generating ./com/theitroad/Calculate.html...
Generating ./com/theitroad/package-summary.html...
Generating ./com/theitroad/package-tree.html...
Generating ./constant-values.html...
Building index for all the packages and classes...
Generating ./overview-tree.html...
Generating ./index-all.html...
Building index for all classes...
Generating ./allclasses-index.html...
Generating ./allpackages-index.html...
Generating ./deprecated-list.html...
Building index for all classes...
Generating ./allclasses.html...
Generating ./allclasses.html...
Generating ./index.html...
Generating ./help-doc.html...

现在打开该目录 Calculate.java存储文件。
你会发现几个 html文件在那里,打开 index.html文件进入浏览器,页面将是这样的。

点击一下 Calculate类,你会看到类结构。

向下滚动页面,我们将看到方法列表 Calculate类。

你可以看到一个新的 search box,在这里搜索任何文本,我们将获得建议。