JavaDoc是一种用于生成API文档的工具，它详细记录了Java代码中的类、方法、参数等信息。API是应用程序编程接口，允许软件之间进行交互。JavaDoc的注释如@author、@version、@param、@return和@throws等帮助创建清晰的文档。开发者可以通过命令行或IDE如IntelliJ IDEA来生成Javadoc，确保代码的可读性和易用性。
JavaDoc生成文档
- javaDoc是用来生成直接的API文档的
- 什么是API？
有时候，软件开发人员想要让自己的软件被其他应用软件所应用，而不是让具体的人来使用。因此互动就是和其他软件之间的，而不是一个人，所以就需要达成一个约定的方式去互动。这种语言，和其内在的一系列规则就被称作应用程序编程接口（API）。基本上，API使各种应用软件互相通信成为了可能。
你的软件与API之间的信息交换经常表现为一个请求和一个回应的形式。你的软件用API发出一个请求，另一个程序则通过API返回响应。
有的API被用来在产品和外来产品之间交换数据。如果你想与Google 或Twitter交互，你可以参考他们的API来写代码，从而在你的产品和他们的产品之间进行数据交换。
有的API被用来在一个公司内部或者一个产品之间进行内在数据交换。Windows和Android操作系统都有内嵌API，以便开发人员编写出可以让系统中不同模块互相通信的子程序。
还有的API被用与内部以及外部的交流。亚马逊网站服务中有40多个服务都有给任何人使用的API。亚马逊开发人员也会自己使用这些API，使各种服务之间可以互相通信。
不管是被内部还是外部使用，API都需要形成文档，以确保产生通信。
- 参数信息
- @author 作者名
- @version 版本号
- @since 指明需要的最早使用的jdk版本
- @param 参数名
- @return 返回值情况
- @throws 异常抛出情况
我们可以在cmd中实现Java doc文档
这里生成了一些东西，我们进入文档打开一个html
我们也可以在idea中生成Java doc文档
扫一扫
818
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
