Java基础12：JavaDoc生成文档

最新推荐文章于 2023-04-24 11:13:27 发布

工一木子

最新推荐文章于 2023-04-24 11:13:27 发布

阅读量136

点赞数 1

分类专栏： JavaSE复习

本文链接：https://blog.csdn.net/Prince140678/article/details/117598323

版权

JavaSE复习专栏收录该内容

68 篇文章 2 订阅

订阅专栏

Java基础12：JavaDoc生成文档

Java Doc

javadoc命令是用来生成自己API文档的
参数信息
- @author 作者名
- @version 版本号
- @since 指明需要最早使用的jdk版本
- @param 参数名
- @return 返回值情况
- @throws 异常抛出情况

效果图：

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Lyvzkhfo-1622880644611)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20210605155226127.png)]$

语法格式：

javadoc 参数 java文件名

代码show

demo01:

package com.gongyi.base;

/**
 * @author gongyi
 * @version 1.0
 * @since 1.8
 */
public class Doc {
    String name;


    /**
     * @param name
     * @return
     * @throws Exception
     * @author gongyi
     */
    public String test(String name) throws Exception {
        return name;
    }
}

备注：

1.类名文档注释需要ieda配置

方法注释，输入/**回车默认就会有@param,@return,@throws(如果有异常抛出的话)

彩蛋

1.在线查看JDK帮助文档

1）打开百度，输入JDK帮助文档

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-rdGcInDL-1622880644615)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20210605155516751.png)]$

2）点击圈中的即可

第一个：

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-icTbgqGn-1622880644619)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20210605155556743.png)]$

官方：
在这里插入图片描述

2.命令行输出生成javadoc

1）在文件管理器打开要操作的类

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-EjIKoDjo-1622880644627)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20210605154228419.png)]$

2）调出CMD黑窗口

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-fmMw6vaa-1622880644628)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20210605154307346.png)]$

回车

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-xrPNSJdf-1622880644629)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20210605154332482.png)]$

设置黑窗口字体大小

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-rU3dJcsb-1622880644631)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20210605154815036.png)]$

选择属性：

把字体设置为20：

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-eqJaNQPY-1622880644632)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20210605154915345.png)]$

3）输入命令

C:\Users\Administrator\Desktop\学习笔记\JavaSE笔记\codes\EmptyProject\JavaBasicStudy\src\com\gongyi\base>javadoc -encoding UTF-8 -charset UTF-8 Doc.java

回车：

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-yz9snxrd-1622880644633)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20210605155001301.png)]$

4）去目录下查看

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-BacdWZs2-1622880644634)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20210605155029564.png)]$

点击index.html

在这里插入图片描述

3.使用IDEA生成javadoc文档（面向百度编程）

参考教程

在这里插入图片描述

有中文报错：【不影响最终生成结果】

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-DnEvduvI-1622880644641)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20210605160609479.png)]$

添加参数即可：

-encoding UTF-8 -charset UTF-8

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-XrwnHahd-1622880644642)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20210605160932197.png)]$

生成结果：(默认不生成@author信息，在导出时可以勾选)

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-7bMVFeFW-1622880644643)(C:\Users\Administrator\AppData\Roaming\Typora\typora-user-images\image-20210605160516703.png)]$