Javadoc 生成文档

javadoc使用可以将在代码中的注释生成文档,方便其他开发者调用。本文不对javadoc作详细的介绍,只记录最简单最常用的情景。
使用方法:
javadoc 选项 包名
选项:
-public
只显示公有类及成员。
-protected
只显示受保护的和公有的类及成员。这是缺省状态。
-package
只显示包、受保护的和公有的类及成员。
-private
显示所有类和成员。
-windowtitle 窗口标题
-d doc 生成在doc 目录下
乱码问题,根据项目的编码设置:
-encoding gbk -charset gbk

示例(cmd下先进src目录):

javadoc -public -d doc -windowstitle API文档 com.pocketdigi com.pocketdigi.video

上面的命令,生成com.pocketdigi和com.pocketdigi.video两个包中,带public修饰符的类和方法的文档,生成的html标题为API文档,存放在doc目录下
另外,简单一点,可以使用Eclipse的导出功能,导出javadoc

© 2012, 冰冻鱼. 请尊重作者劳动成果,复制转载保留本站链接! 应用开发笔记