怎么生成java API文档?怎么看java API文档?

今夕 205 2023-10-31


java怎么生成API文档

java怎么生成API文档,本文简单介绍在dos下生成API的方法。

步骤

1.首先进入dos环境,输入java -version查看电脑是否安装了jdk,也就是java运行环境,没有安装的话需要先安装,不然是无法生成API的,安装jdk的步骤可以上网查询,很简单。

image.png

2.然后进入java文件所在的路径。

image.png

3.生成API前,最好先编译一下java文件看是否有错误,没有错误再继续,编译java文件用javac -d . HelloWorld.java。

image.png

4.如果java文件没有问题的话,会在java文件的路径生成class文件。

image.png

5.编译没有问题之后,就可以用javadoc HelloWorld.java生成API文档。

image.png

6.然后在java文件的路径下,就会生成一些html,css的文件,这些就是生成的API文档页面。

image.png

7.打开里面的index.html,就可以看到生成的API文档了。

image.png



怎么看java API文档?

学习java最好要自己学会看API文档,不管是听老师讲课还是自己看书,都不可能将所有的类,方法等记住。而查阅API文档就显得尤为重要。

步骤

1.首先,要知道API文档有很多版本,有英文版的,也有中文版的。

image.pngimage.png

2.而对于初学者,或者英语不好的同学,可以先看看中文版的!:)

image.png

3.在文档的左侧,上一部分有很多java包,如果你要查看每个包里都有哪些类,接口,直接点击就可以了。在左侧下面一部分会列出包下所有类,接口和其他的一些东西。

image.png

4.若是单独想要查询某个方法、接口或类,可以利用索引,按照字母查询。

image.png

5.例如,我们要查询pack(),这个方法的用法和作用。直接点击字母p,在下面就可以找到了。

image.png

6.然后单击pack(),就可以查看到关于pack()的一些内容了!:)

怎么看java API文档?

7.当然,也可以直接在左侧的索引里输入你要找的内容进行查找!:)

image.png



版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。

上一篇:药品接口质量管理制度内容 - 深入了解药品接口质量管理制度的重要内容
下一篇:私有云服务器,私有云服务平台
相关文章

 发表评论

暂时没有评论,来抢沙发吧~