注册 登录  
 加关注
   显示下一条  |  关闭
温馨提示!由于新浪微博认证机制调整,您的新浪微博帐号绑定已过期,请重新绑定!立即重新绑定新浪微博》  |  关闭

0与1构筑世界,程序员创造时代

软件架构设计 Java编程

 
 
 

日志

 
 

(原创)JavaDoc用法  

2006-03-17 11:13:54|  分类: Java |  标签: |举报 |字号 订阅

  下载LOFTER 我的照片书  |

JavaDoc用法

-----------------------------------------------------------------------------------------------------------------

用法:javadoc [options] [packagenames] [sourcefiles] [@files]

 

Options

Description

-overview <file>           

读取 HTML 格式的概述文档

-public                   

仅显示 public 类和成员

-protected                

显示 protected/public 类和成员(缺省)

-package                

显示 package/protected/public 类和成员

-private                  

显示所有类和成员

-help                    

显示命令行选项

-doclet <class>           

通过候选 doclet 生成输出

-docletpath <path>       

指定 doclet 类文件的查找位置

-1.1                     

利用 JDK 1.1 模仿 doclet 生成输出

-sourcepath <pathlist>   

指定源文件的查找位置

-classpath <pathlist>    

指定用户类文件的查找位置

-bootclasspath <pathlist>

覆盖自举类加载器所加载的类文件的位置

-extdirs <dirlist>       

覆盖已安装的扩展的位置

-verbose                

有关 Javadoc 所做工作的输出信息

-locale <name>           

所用的 Locale,例如 en_US en_US_WIN

-encoding <name>         

源文件编码名称

-J<flag>

<flag> 直接传给运行时系统

由标准 doclet 提供:

-d <directory>

输出文件的目标目录

-use

创建类和包的用法页

-version

包含 @version

-author

包含 @author

-splitindex

将索引分为每个字母对应一个文件

-windowtitle <text>

文档的浏览器窗口标题

-doctitle <html-code>

包含包索引页(首页)的标题

-header <html-code>

包含每一页的页眉文本

-footer <html-code>

包含每一页的页脚文本

-bottom <html-code>

包含每一页的页底文本

-link <url>

创建到 javadoc 输出的链接(位于 <url>

-linkoffline <url> <url2>

利用位于 <url2> 的包列表链接到位于 <url> 的文档

-group <name> <p1>:<p2>..

将概览页中指定的包分组

-nodeprecated

不包含 @deprecated 信息

-nodeprecatedlist

不生成不鼓励使用的列表

-notree

不生成类层次

-noindex

不生成索引

-nohelp

不生成帮助链接

-nonavbar

不生成导航栏

-helpfile <file>

包含帮助链接功能链接到目标的文件

-stylesheetfile <path>

改变所生成文档的样式的文件

-docencoding <name>

输出编码名称

   javadoc工具可以从java源文件中解析出类、方法以及/**...**/注释,产生HTML文档,采用与JDKAPI文档相同的格式。我们可以采用这个工具很方便的生成专业的说明文档。javadoc.exe包含在标准的JDK中。

javadoc工具可从下列对象中提取出信息:包、公共类、公共接口、公共或受保护方法、公共或受保护变量/常数。

 

下面介绍典型的几种用法,能够覆盖到您大部分的要求。

1.处理一个java源文件,命令如下:Javadoc

  评论这张
 
阅读(1243)| 评论(0)
推荐 转载

历史上的今天

评论

<#--最新日志,群博日志--> <#--推荐日志--> <#--引用记录--> <#--博主推荐--> <#--随机阅读--> <#--首页推荐--> <#--历史上的今天--> <#--被推荐日志--> <#--上一篇,下一篇--> <#-- 热度 --> <#-- 网易新闻广告 --> <#--右边模块结构--> <#--评论模块结构--> <#--引用模块结构--> <#--博主发起的投票-->
 
 
 
 
 
 
 
 
 
 
 
 
 
 

页脚

网易公司版权所有 ©1997-2017