MyEclipse生成Javadoc帮助文档[整理]

Javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形式程序的开发文档了。 

Javadoc输出的是一些静态网页文档，经过WEB浏览器来查看它。

Javadoc只能为public或者protected成员停止文档注释。private和包内访问的成员的注释会被忽略掉。那样做是有道理的，由于只有public和protected成员才能在文档之外被应用，这也体现了封装性的优点。

 

一、利用Myeclipse都可轻松制作javadoc

利用Myeclipse生产javadoc文档的步骤如下：

1.选择File->Export->javadoc，下一步。

2.Javadoc comand选择JDK的bin目录下的javadoc.exe。选择要生成的源代码和javadoc保存的目的路径，下一步。

3.Document title输入标题，下一步。

4.Extra Javadoc options输入

-windowtitle 'Type B Monitor'[浏览器显示标题]

-bottom <center>Travelsky</center>[底部显示文本]，

-encoding UTF-8 -charset UTF-8[项目对呀编码]

更多参数详见

 

二、利用3个插件都可轻松制作javadoc

JDocEditor,JAutoDoc,Java2Html。三个小工具，轻松制作JavaDoc.一个是可见即所得的JavaDoc编辑工具，一个是自动建立代码注释的工具，一个是把代码转换成Html格式的工具。
JDocEditor:
http://www.certiv.net/download/downloads.html#jdoceditor
一个所见即所得的Java Doc 编辑器。不用再费神地在代码中调整注释的html标记了，可以自由地编出高质量的带丰富格式的Java Doc 。

JAutoDoc
http://jautodoc.sourceforge.net/index.html#download
自动建立Java Doc 文档。功能十分强大，三个命令实现在所有源代码中加入完整的Java Doc注释。一个命令是加入Package的说明文档，在Package中加入package.html，对package进行说明。
第二个命令是代码文件的头部注释。一个命令就可以自动地在项目的所有代码文件中加入头部注释，或者替换原来的注释。
第三个命令为类、方法、属性加入注释说明。可以根据模式匹配，自动地根据方法的名称，建立更为具有可读性的注释文本。

Java2Html
http://www.java2html.de/eclipse.html
准确地说它不是用来直接建立JavaDoc 的，但是可以用来建立其他文档。它的功能是，把Eclipse中的语法色彩格式转换成为Html,让粘贴到网页上，或者其他文档中的代码带有清晰的语法格式。

 

JDoc2Chm

下载htmlhelp.exe，jd2chm.exe

先安装htmlhelp.exe,将jd2chm.exe放在javadoc目录下即/doc目录下,双击jd2chm.exe或者在命令行运行jd2chm.exe，输入相应的标题，即可生成chm.

 

javadoc options

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

-overview <file>          从 HTML 文件读取概览文档
-public                   仅显示 public 类和成员
-protected                显示 protected/public 类和成员 (默认值)
-package                  显示 package/protected/public 类和成员
-private                  显示所有类和成员
-help                     显示命令行选项并退出
-doclet <class>            通过替代 doclet 生成输出
-docletpath <path>        指定查找 doclet 类文件的位置
-sourcepath <pathlist>    指定查找源文件的位置
-classpath <pathlist>     指定查找用户类文件的位置
-exclude <pkglist>        指定要排除的程序包列表
-subpackages <subpkglist> 指定要递归加载的子程序包
-breakiterator            计算带有 BreakIterator 的第一个语句
-bootclasspath <pathlist> 覆盖由引导类加载器所加载的
                           类文件的位置
-source <release>         提供与指定发行版的源兼容性
-extdirs <dirlist>        覆盖所安装扩展的位置
-verbose                  输出有关 Javadoc 正在执行的操作的信息
-locale <name>            要使用的区域设置, 例如 en_US 或 en_US_WIN
-encoding <name>          源文件编码名称
-quiet                    不显示状态消息
-J<flag>                  直接将 <flag> 传递到运行时系统
-X                        输出非标准选项的提要

通过标准 doclet 提供:
-d <directory>                    输出文件的目标目录
-use                              创建类和程序包用法页面
-version                          包含 @version 段
-author                           包含 @author 段
-docfilessubdirs                  递归复制文档文件子目录
-splitindex                       将索引分为每个字母对应一个文件
-windowtitle <text>               文档的浏览器窗口标题
-doctitle <html-code>             包含概览页面的标题
-header <html-code>               包含每个页面的页眉文本
-footer <html-code>               包含每个页面的页脚文本
-top    <html-code>               包含每个页面的顶部文本
-bottom <html-code>               包含每个页面的底部文本
-link <url>                       创建指向位于 <url> 的 javadoc 输出的链接
-linkoffline <url> <url2>         利用位于 <url2> 的程序包列表链接至位于 <url> 的文档
-excludedocfilessubdir <name1>:.. 排除具有给定名称的所有文档文件子目录。
-group <name> <p1>:<p2>..         在概览页面中, 将指定的程序包分组
-nocomment                        不生成说明和标记, 只生成声明。
-nodeprecated                     不包含 @deprecated 信息
-noqualifier <name1>:<name2>:...  输出中不包括限定符的列表。
-nosince                          不包含 @since 信息
-notimestamp                      不包含隐藏时间戳
-nodeprecatedlist                 不生成已过时的列表
-notree                           不生成类分层结构
-noindex                          不生成索引
-nohelp                           不生成帮助链接
-nonavbar                         不生成导航栏
-serialwarn                       生成有关 @serial 标记的警告
-tag <name>:<locations>:<header>  指定单个参数定制标记
-taglet                           要注册的 Taglet 的全限定名称
-tagletpath                       Taglet 的路径
-Xdocrootparent <url>             将文档注释中出现的所有后跟 /.. 的 @docRoot 替换为 <url>
-charset <charset>                用于跨平台查看生成的文档的字符集。
-helpfile <file>                  包含帮助链接所链接到的文件
-linksource                       以 HTML 格式生成源文件
-sourcetab <tab length>           指定源中每个制表符占据的空格数
-keywords                         使程序包, 类和成员信息附带 HTML 元标记
-stylesheetfile <path>            用于更改生成文档的样式的文件
-docencoding <name>               输出编码名称