千家信息网

MyEclipse中怎么生成javadoc文档

发表于:2025-02-01 作者:千家信息网编辑
千家信息网最后更新 2025年02月01日,这篇文章给大家介绍MyEclipse中怎么生成javadoc文档,内容非常详细,感兴趣的小伙伴们可以参考借鉴,希望对大家能有所帮助。一。右键项目,选择Export二。选择java下面的javadoc三
千家信息网最后更新 2025年02月01日MyEclipse中怎么生成javadoc文档

这篇文章给大家介绍MyEclipse中怎么生成javadoc文档,内容非常详细,感兴趣的小伙伴们可以参考借鉴,希望对大家能有所帮助。

一。右键项目,选择Export


二。选择java下面的javadoc


三。create javadoc for members with visibility解释
private 所有类和成员都生成

package除了前边带private的私有类和成员,其他都生成。

protected 前边带protected和public的都生成。

public 前边public的生成。(默认)

四。选好路径


五。选择引用文件和项目以生成链接。(全选就行,也就是下图的Select All,警告忽略)


六。Extra javadoc options填上(-encoding 编码名 -charset 编码名,项目是UTF-8编码的就用下图方式),JRE source compatibility 我的jdk是1.7的所以我选的1.7.然后点Finish


七。在cmd下 运行javadoc可以显示出所有的命令选项,可以填在Extra javadoc options上,下面列出来。


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

通过标准 doclet 提供:
-d 输出文件的目标目录
-use 创建类和程序包用法页面
-version 包含 @version 段
-author 包含 @author 段
-docfilessubdirs 递归复制文档文件子目录
-splitindex 将索引分为每个字母对应一个文件
-windowtitle 文档的浏览器窗口标题
-doctitle 包含概览页面的标题
-header 包含每个页面的页眉文本
-footer 包含每个页面的页脚文本
-top 包含每个页面的顶部文本
-bottom 包含每个页面的底部文本
-link 创建指向位于 的 javadoc 输出的链接
-linkoffline 利用位于 的程序包列表链接至位于 的文档
-excludedocfilessubdir :.. 排除具有给定名称的所有文档文件子目录。
-group :.. 在概览页面中, 将指定的程序包分组
-nocomment 不生成说明和标记, 只生成声明。
-nodeprecated 不包含 @deprecated 信息
-noqualifier ::... 输出中不包括限定符的列表。
-nosince 不包含 @since 信息
-notimestamp 不包含隐藏时间戳
-nodeprecatedlist 不生成已过时的列表
-notree 不生成类分层结构
-noindex 不生成索引
-nohelp 不生成帮助链接
-nonavbar 不生成导航栏
-serialwarn 生成有关 @serial 标记的警告
-tag ::

指定单个参数定制标记
-taglet 要注册的 Taglet 的全限定名称
-tagletpath Taglet 的路径
-Xdocrootparent 将文档注释中出现的所有后跟 /.. 的 @docRoot 替换为
-charset 用于跨平台查看生成的文档的字符集。
-helpfile 包含帮助链接所链接到的文件
-linksource 以 HTML 格式生成源文件
-sourcetab 指定源中每个制表符占据的空格数
-keywords 使程序包, 类和成员信息附带 HTML 元标记
-stylesheetfile 用于更改生成文档的样式的文件
-docencoding 输出编码名称

生成doc的效果:

关于MyEclipse中怎么生成javadoc文档就分享到这里了,希望以上内容可以对大家有一定的帮助,可以学到更多知识。如果觉得文章不错,可以把它分享出去让更多的人看到。

0