工具类的文档注释
工具类:一般都定义成静态的,只提供工具方法,没有特定数据,不需要构建对象。
为了保证不让其他成员创建对象,将无参的构造函数设置为私有化即可。
源文件:
@author 作者
@version 版本
@param 参数
@return 返回
生成html中的文档化:
注意1:
在每个方法前面加上一个/** * / 文档注释 但是 private 的方法 无法显示到文档
注意2:
如果想进行文档化
类名必须是public的 而且类名与文件名必须一致
D:\javacode\myeclipse\毕向东Java学习视频练习\src\day08>javadoc -d my -author -ve
rsion ArrayTool.java
含义:
javadoc -d ./mydoc -author -version ArrayTool.java
javadoc:dos命令 文档化
-d :后加输出文件的输出目录
. :当前目录
mydoc : 当前文件夹创建mydoc并且输出到该文件夹
-author & -version :文档化中所包含的内容有作者和版本
ArrayTool.java 文档化的目标文件
执行后:生成文件
Cd my
点击index.html
生成javadoc的文件
可以对自己定义的方法进行功能查看