javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。
常用的Tag:
在编写完文档注释和代码之后,进行如下操作:
在IDEA中点击 Tools > Generate javadoc:
进入:
解释说明:
Whole project:整个项目都生成文档
Custom scope: 自定义范围。
include JDK and … : 包含jdk和其他的第三方jar
link to JDK documentati