如何生成带注释文档的JAR包?

首先，生成javadoc目录：
参考这里使用 eclipse 制作 javadoc 文件

然后，生成 JAR 文件
参考这里JAR 文件的生成与使用

注意，需要把 doc 目录与 src目录一起打包，截图如下：

生成的SBUtil.jar 以zip解压后，可以看到含有doc目录，说明的确连同 javadoc 文档都一同打包进来了，截图如下：

最后一步，就是把 JAR 包的注释文档，关联到 JAR 包本身，操作：Referenced Libraries | 右键 |属性 ，截图如下：

选择 Javadoc Location 栏目，选择 Javadoc in archive(注释文档 存于 归档文件中)，分别点击 “Browse …” 选择“./libs/SBUtil.jar” 与 “doc”子目录，OK。

效果如下：

小结：
1. 优点 & 缺点。生成 含有 doc 的 JAR 包，虽然方便了开发（在隔离源码的前提下），增强 JAR 代码的可读性，有利于团队间的代码复用，但是增加 JAR 包的体积（我目前没有数据支持，以后再补充数值分析）。
2. 维护的成本。如果是同时兼顾　开发版本　与　正式版本，那么最好是生成以下2种 JAR：
(1) 含有 doc 目录的 JAR，用于开发期，目的是提高开发效率，减小沟通成本（具体效果也不一定显著）。
(2) 只对 src 打包的JAR，用于正式发布版本，并且同时要生成 javadoc 目录（有条件的可以上专到公司内部网络上 或 Google 项目托管上），以供他人参考。
3. javadoc 与 JAR 版本同步。这个要求对于一般的程序员，以及小公司显然过度了，也许2个周就开发完成，都没有时间去整理 & 维护 javadoc。但若对自己的代码库很自信，觉得可以流传后世的DEV，请加上 @since @version & @auther。