昨天下午开始把平时经常用到的一些工具类整理到了一块,封装成了一个jar包。但是,缺少一个,帮助文档,方便别人使用。
问题来了,不会制作 api文档,在网上找了一些方法,最终决定,用命令的方式来完成api帮助文档的创建。
步骤如下:
第一步:
在工程目录的 src下创建 文件:package.txt .
我的路径是这样的:F:\watermusic\MyProject\zwhy\MyUtil\src ,即:在src 下创建,package.txt 。
第二步:
打开doc命令窗口,切换到 F:\watermusic\MyProject\zwhy\MyUtil\src 这个路径下。
输入命令:javadoc -d api @package.txt
回车,这样就可以,生成api 帮助文档了。