4.JavaDoc理解

一、前景提要

作用:JavaDoc命令是用来生成自己的 API文档的!

 

先查阅一下java8的官方文档

 

 写在类上面就是类注释,写在方法上面就是方法注释!

 

 

二、命令行生成文档

那么写了注释有什么作用呢?

选中当前类,右键选择从文件中打开。

 

 用命令行方式生成文档,在文件路径前面输入 cmd 空格 + enter,cmd窗口就会出现,输入如下命令行!

编码用 UTF-8, 字符集编码也用 UTF-8  这个参数的作用是能多显示一点中文,避免遇到中文乱码问题。

 

会发现下面多了一堆东西:

 点击 index.html ==》这个相当于首页的意思。会发现里面的结构和java8官方文档结构一致!

 

 

三、IDEA生成文档

(1条消息) IntelliJIDEA生成JavaDoc_今天只卖大白菜的博客-CSDN博客_生成javadoc

posted @ 2022-03-29 08:47  Jukim  阅读(68)  评论(0编辑  收藏  举报