<%@ page contentType="text/html; charset=gb2312"%> Javadoc的简捷使用
网站公告:   ◆北天JAVA技术网热情为java爱好者服务,本网内容包括JAVA(JSP、servlet、EJB、webservice、j2ee、javabean、应用服务器、JavaScript),数据库(MYSQL、SQL Server、Sybase、Oracle、DB2、数据库综合知识),设计研究(设计模式、Struts、Spring、Hibernate、设计框架、设计综合知识),WEB2.0新技术(主要介绍AJAX),以及各种技术的入门、实例、例子等等,欢迎各位多来坐坐!◆  诚邀各位JAVA爱好者加盟!◆  本网站内容丰富,更新快,保证每周20篇以上!  
加入收藏
设为首页
联系站长
承接项目
  相关资源:网站首页 | 免费培训学院 | 技术论坛 | JAVA聊天室 | 作家专栏 | 开发工具 | 认证考试 | 会员俱乐部
  JAVA技术初学者园地 | jsp与servlet | javascript | Java源代码 | EJB | web service | 应用服务器 | JAVA综合知识
  设计研究设计模式 | 设计框架 | Struts | Spring | Hibernate | 开源项目 | 面向对象设计 | 设计综合知识
  数 据 库MYSQL | SQL Server | Sybase | Oracle | DB2 | Informix | Access | 数据库综合知识
  其他资源:AJAX新技术 | 网站开发 | ERP软件 | OA办公软件 | 商业智能BI | 开发综合知识 | 承接项目 | 项目试用

 
 
Javadoc的简捷使用
     发布者: 发布时间:2007-03-07

   J2SE5中的javadoc.exe的命令行可选参数多达五十余个,其复杂性可想而知,是不是看着头都大了呢?但通常情况下,我们不想那么麻烦!
                                                                                     
假设源代码在 C:\src 目录下,其中 com.liigo 是主包,其下可能有数十个子包,数百(千)个Java文件。目录结构大约是这样的:

- C:\
    | src\
      | com\
        | liigo\

           | ***
怎么才能以最简捷的方式生成所有的API文档呢?

c:\>
c:\>cd src
c:\src>javadoc -d doc -subpackages com.liigo

这样就搞定了,最终生成的API文档位于 c:\src\doc 目录(该目录是由javadoc.exe自动生成的)。

上面的用法利用了“当前目录”和“相对路径”,当然也可以用绝对路径:

...>javadoc -d c:\doc -sourcepath c:\src -subpackages com.liigo

最终生成的API文档位于 c:\doc 目录(该目录同样是由javadoc.exe自动生成的)。


总结一下:

我们只用到了javadoc的三个参数: -d,-subpackages,-sourcepath,其中:

参数 说明
-d 指定API文档的输出目录,默认是当前目录。建议总是指定该参数。
-sourcepath 指定源代码路径,默认是当前目录。 此参数通常是必须的。
-subpackages 以递归的方式处理各子包。关键参数!如果不使用本参数,每次只能处理一个子包(或需手工列出所有子包)。

注:以上示例要求 javadoc.exe 所在路径位于系统环境变量“PATH”中。

补充一点:

     使用参数 -author 可以将作者信息(@author ***)导出到最终生成的API文档中, -version 可以生成版本信息。如果是自己写的一个包,千万不要忘了用 -author 哦:)

最终完整的命令行是:

...>javadoc -d c:\doc -sourcepath c:\src -subpackages com.liigo -author -version

(转载文章请保留出处:北天JAVA技术网(www.java114.com))
 
更多精彩文章:
用instanceof检测对象的类型
在运行时实现Java的多态性
你知道什么是缄默溢出吗?
Java类装载机制要义
“聊天”里的程序人生
Java2下Applet数字签名具体实现方法
 
最近评论:
        
你曾悄悄的来过!
wow gold,wow gold,wow gold,ffxi gil max(1574)
        
你曾悄悄的来过!
wow gold,wow gold,wow gold,ffxi gil max(2940)
        
你曾悄悄的来过!
wow gold,wow gold,wow gold,ffxi gil max(6987)
        
你曾悄悄的来过!
wow gold,wow gold,wow gold,ffxi gil max(9746)
        
你曾悄悄的来过!
wow gold,wow gold,wow gold,ffxi gil max(907)
        
你曾悄悄的来过!
wow gold,wow gold,wow gold,ffxi gil max(3980)
        
冰封的往事!
wow power leveling,wow gold,WoW Gold,wow gold max(3541)
        
飞舞的传奇!
传世私服,传世私服.传奇世界私服传奇世界私服,传世私服传世私服, 传奇世界私服传奇世界私服.传奇私服传奇私服. max(1863)
        
标 题:   
内 容:   
 
                                  
 
免责声明:该文章由网友发表,如果对您造成侵权,请联系站长

首页 - 承接项目 - 网站地图 - 联系我们 -
版权所有北天JAVA技术工作室 ICP证号:粤ICP备06079815号