（转）创建和查看Javadoc文档

原地址：http://jinnaxu-tju-edu-cn.iteye.com/blog/667177

Javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形式程序的开发文档了。 
javadoc是生成一个java api文档生成工具，存在于jdk安装目录下的bin目录中。 
说明：生成javadoc 不要求你的java代码是可编译的。唯一要求的是存在.java文件。 
javadoc在eclipse等IDE中使用比较方便，在命令行中使用需要考虑很多参数。可以同多在命令行执行 
javadoc -help 
查看参数。 
这里说几个常用的： 
1、如果你在中文系统下使用的源代码编码是UTF-8，你还想输出中文的javadoc，需要指定： 
1）要使用的语言环境：-locale zh_CN 
2）设置源码编码方式：-encoding UTF-8

2、排除一些包，包之间用冒号分隔。 
-exclude [包路径]:[包路径]:...

3、生成文档的标题栏标题 
-windowtitle [标题栏标题文字]

4、生成文档题目 
-doctitle [文档题目]

在eclipse下创建和查看javadoc文档，详细说明： 
1、设置javadoc的命令位置，在eclipse工作台的菜单栏选择【project->Generate JavaDoc】命令，弹出图1所示对话框。 
在该对话框中，可以在“Java Command”字段中输入JavaDoc启动命令的绝对路径。

 
2、单击【Next】，跳到如图2所示的窗口，选择需要生产javadoc文档的元素。

 
3、单击【Next】，跳到图3所示的对话框，在该对话框中可以在文本区域内设置JavaDoc的参数。

 
4、单击【finish】，完成对javadoc的创建。 
说明：javadoc文档生成后，在“包自愿管理器”视图中对应的项目目录下，将会多出“doc”和“doc.resources”两个包。 
同时，在“javadoc”视图中也可以查看该元素的信息。

 
也可通过浏览器查看javadoc，在菜单栏中选择【Natigate->Open External JavaDoc】命令或是快捷键shift+F2.