JavaDoc生成文档
JavaDoc是什么?
javadoc是Sun公司提供的一个技术,它从程序 源代码 中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。 也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。
- javadoc命令是用来生成自己API文档的
- 参数信息
- @author 作者名
- @version 版本号
- @since 指明需要的最老的jdk版本
- @param 参数名
- @return 返回值情况
- @throws 异常抛出情况
深入了解JavaDoc
进入刚才编辑的java文件所在的文件夹
在文件夹内打开终端,用javadoc命令执行刚才编辑的java文件,UTF-8 -charset UTF-8是为了防止出现乱码,起美化作用的参数:
执行完后,可以发现原本空荡荡的文件夹内,出现了很多文件
其中有一个名为index.html的文件,这个文件就是我们javadoc的主要“工作成果”,打开index.html文件,就能看到一个展示了你刚刚编辑过的java文件的详细信息的网站: