爪哇 9– 爪哇 文档改进
爪哇 has upgraded its 爪哇 文档
对于 better user 整型 eraction 和 user-experience. It includes a simplified 搜索, HTML generator, Doclet API, etc.
什么是Javadoc
The 爪哇 文档
is a tool like 爪哇 c
和 a part of JDK
. It is used to generate HTML doc umentation of 爪哇 资源 code. If you ever visit to oracle site you will see 的 爪哇 doc umentation which is generated by 爪哇 文档. The upgraded 爪哇 文档 has 的 following features.
简化的Doclet API
In 爪哇 9, old Doclet API
has been replaced with a new simplified API. Although 的 existing API is still supported 和 available but you can use 的 new Doclet API.
支持HTML5
It supports 的 HTML5 对于 better user 整型 erface 和 tools. So 的 new 爪哇 文档
is based on HTML5
版.
改进的搜索
爪哇 文档 provides a new 搜索 box
to find 类 , 包装, methods. It provides better suggestion 和 accurate 搜索 in a moment.
支持模块系统
它有助于基于新的Java平台模块系统生成文档。
让’s take an example.
如何从Java源文件创建HTML 爪哇 文档。
让’s创建一个示例,以从Java源文件生成新的HTML5文档。在这里,我们创建了一个包含一些方法的Calculate类。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
包 com . 爪哇 2blog; / ** *提供计算基本算术运算的方法。 * @作者Irfan * @版本1.0 * * / 上市 类 计算 { / ** *返回两个整数的和 * * @参数a和b为整数类型 * / 上市 整型 加 ( 整型 a, 整型 b){ 返回(a+b); } / ** *返回两个整数的减法 * * @参数a和b为整数类型 * / 上市 整型 子 ( 整型 a, 整型 b){ 返回(a-b); } / ** *返回两个整数的乘积 * * @参数a和b为整数类型 * / 上市 长 多 ( 整型 a, 整型 b){ 返回( 一个* b); } / ** *返回两个整数的除法 * * @参数a和b为整数类型 * / 上市 浮动 div ( 整型 a, 整型 b){ 返回(a/b); } } |
运行Javadoc命令
To create 爪哇 文档, use 的 following com mand. execute it using cmd
or terminal
after reaching to 爪哇 文件 location.
1 2 3 |
爪哇 文档 -d . - html 5 计算. 爪哇 |
它将向控制台生成一些正在处理指令的消息。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
载入中 资源 文件 计算. 爪哇 ... 建造中 爪哇 文档 信息... 标准 Doclet 版 11.0.8 建造 树 对于 所有 的 包装 和 类... 产生中 ./ com / 爪哇 2blog/计算. html ... 产生中 ./ com / 爪哇 2blog/包-概要. html ... 产生中 ./ com / 爪哇 2blog/包- 树 . html ... 产生中 ./不变-价值观. html ... 建造 指数 对于 所有 的 包装 和 类... 产生中 ./概观- 树 . html ... 产生中 ./指数 - 所有 . html ... 建造 指数 对于 所有 类... 产生中 ./所有类-指数 . html ... 产生中 ./所有包装-指数 . html ... 产生中 ./不推荐使用- 清单 . html ... 建造 指数 对于 所有 类... 产生中 ./所有类. html ... 产生中 ./所有类. html ... 产生中 ./指数 . html ... 产生中 ./ 救命 - doc . html ... |
Now open 的 directory in which 计算.java
文件 is stored. You will find several html
文件 s 的 re, open 指数 .html
文件 整型 o 的 browser 和 的 page would be like this.
Click on 的 计算
类 和 you will see 的 类 structure.
Scroll down 的 page 和 you will see 的 清单 of method belongs to 计算
类 .
And you can see a new 搜索 box
, 搜索 here with any text 和 you will get 的 suggestions.
Well, this is 所有 about 爪哇 文档
, It is easy 和 good tool to create a informative HTML doc using Source code.