JavaDoc

JavaDoc

javadoc命令是用来生成自己API文档的

参数信息

• @author 作者名
• @version 版本号
• @since 指明需要最早使用的jdk版本
• @param 参数名
• @return 返回值情况
• @throws 异常抛出情况

在dos中生成JavaDoc文档

命令格式： javadoc 参数 Java文件

1. 右键Doc.java，选择在explorer中打开
2. 在地址栏首部输入cmd空格，再回车
3. 键入命令javadoc -encoding UTF-8 -charset UTF-8 Doc.java
4. 回车

在idea中生成JavaDoc文档

菜单栏Tools-Generate JavaDoc

1. 选择⽣成JavaDoc⽂档的范围，我只对⼀个源⽂件⽣成Doc，所以选择⽂件
2. 输出⽬录最好新建⼀个⽂件夹，⽐较有条理和整洁
3. 区域设置，决定⽂档的语⾔，简体中⽂就是zh_CN、繁体(台湾)zh_tw、繁体(⾹港)zh-hk、英语(⾹港)en-hk、英语(美
   国)en-us、英语(英国)en-gb、英语(全球)en-ww
4. 其他命令⾏参数：如果区域设置为中国，参数⼀般为 -encoding UTF-8 -charset UTF-8 主要意义是为了显⽰中⽂不出现乱码
5. 设置完成后点击确定即可⽣成Doc⽂档
6. 在输出目录中打开index.html便能看到生成的文档