天天看点

Javadoc命令与API

Javadoc工具会抽取类,成员,方法的文档注释生成与这个类配套的API帮助文档

Javadoc命令和文档注释小公司基本不用,但我们应养成良好的编码习惯,所以还是了解一下

文档注释可以写的大致信息为:

图片

可以使用命令行或者idea使用Javadoc工具生成API帮助文档

使用idea生成文档

IDE可以帮我们很快就直接生成API文档,但是这对我们的学习不一定是好的,所以我们还得自己操作一遍用命令行生成文档

最好有时间都记住,虽然平时不咋用,但对我们理解有一定的帮助

使用命令行生成文档

什么是API?

用通俗易懂的话来说,就是一个函数,我们想拿上用,但又不想看它的源码,就想直接知道它的功能和使用方法,直接拿上用,这个函数就是API。

API在Java中就是一个类,我们不想看这个类的代码,就想直接拿上用,这个类就是API。

什么是API文档?

就是解释API的功能和使用方法。

继续阅读