创建和导入java doc

公司不同的team直接协作，总有一些代码是通用的，尤其是在自动化测试当中。那么有必要把一些写好的方法库export成jar，方便他人使用。当他人import你的jar后，发现看不到方法的说明文档，无法很好的调用jar中的方法。这样就需要你在export jar的同时也生成java doc一并share出去，拿到的人就可以讲java doc一并导入，方便多了。

没有文档就像这样:

1. 生成java doc（你的操作）

首先要保证你写的method都有标准的java说明，像这样：

/**

* print string as given

* @param str string you want to show

*/

public static void show(String str) {

System.out.println(str);

}

然后选中你要导出的project，在eclipse中选择project->generate javadoc...，弹出如下对话框（另外，选中你的project，右键->Export->javadoc 也能来到下面对话框）

Javadoc command:一栏中填写jdk中javadoc命令的路径：/Library/Java/JavaVirtualMachines/jdk1.8.0_40.jdk/Contents/Home/bin/javadoc

选择目标project并选择Destination

下一步，有一些不必须但更详细的设置，根据自身情况进行设置。

点击完成后，在上面所选的Destination 路径下即可看到html格式的javadoc。

导出jar很简单，选中你的project，右键->Export->java->JAR file，出现对话框，进行相应设置即可。

2. 导入javadoc（小伙伴的操作）

当你导出了jar和javadoc后，讲jar和生成的doc文件夹copy给你的小伙伴，他便可以准备导入了。

首先选中要导入jar的项目，右键->Properties->java build path，在Libraries tab中选择Add External Jars... 浏览添加你之前导出的JAR

然后在Libraries tab下选中刚添加的JAR项，展开选中@Javadoc Location，点击Edit来制定你要导入的javadoc的路径，最后确定就完成了。

最后，在小伙伴的项目中使用JAR中的方法，即可看到如下javadoc