Javadoc到底是什么??
Javadoc的定义
javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。
Javadoc标签
Javadoc的生成
一、导出javadoc
在进行工程项目开发的时候,必须要对字符编码进行统一,这样可以避免乱码的出现,以及一些莫名其妙的映射问题。通常都是使用 “UTF-8无BOM” 编码格式。
1.1 配置生成
对于一份已经写好详细注释的java工程代码,我们在当前工程名上鼠标右击,会出现下拉选项栏,选择 “Export…”,如下图所示:
接下来在 “Export” 配置页面,选择 “Java -> Javadoc” 选项,然后点击 “Next”,如下图所示:
进入到 “Generate Javadoc” 配置页面后,根据当前系统环境配置好jdk中javadoc命令的绝对路径,同时选择好javadoc文档的输出目录,其它的参数采用默认值即可,然后点击 “Next”,如下图所示:
进入到 “Generate Javadoc” 第二张配置页面后,可以自定义javadoc文档的首页标题,其它的参数采用默认值即可,然后点击 “Next”,如下图所示:
在 “Generate Javadoc” 第三张配置页面中,必须要指定编码格式和字符格式为UTF-8,不然会出现字符映射的问题,导致无法生成javadoc文档,其它的参数采用默认值即可,然后点击 “Finish”,如下图所示:
在 “Update Javadoc Location” 确认页面中,点击 “Yes To All” 允许生成javadoc文档,并输出到指定位置,如下图所示:
此时可以发现,在 “Console” 窗口不断有javadoc文档的生成日志打印输出,如下图所示:
等到日志打印完毕,打开我们预先选定的输出文件目录,可以发现javadoc文档结构如下图所示:
使用浏览器打开index.html文件,基本上都显示正常,至此我们的javadoc文档已经生成成功啦,可以正常使用。但是页面标签名称貌似不对劲,如下图所示:
此时,以文本模式打开index.html文件,修改title标签,如下图所示:
重新载入页面,现在就变得很完美了。我们可以把这个javadoc文档外发给别人。