生成JavaDoc文档

2021-06-07 09:04

阅读:456

YPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">

标签:类加载器   boot   not   styles   less   offline   cte   ado   默认值   

使用命令行生成

javadoc命令生成自己的api文档

javadoc [options] [packagenames] [sourcefiles] [@files]

参数:

  -overview                  从 HTML 文件读取概览文档
  -public                          仅显示 public 类和成员
  -protected                       显示 protected/public 类和成员 (默认值)
  -package                         显示 package/protected/public 类和成员
  -private                         显示所有类和成员
  -help                            显示命令行选项并退出
  -doclet                   通过替代 doclet 生成输出
  -docletpath                指定查找 doclet 类文件的位置
  -sourcepath            指定查找源文件的位置
  -classpath             指定查找用户类文件的位置
  -cp                    指定查找用户类文件的位置
  -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 的路径 -charset 用于跨平台查看生成的文档的字符集。 -helpfile 包含帮助链接所链接到的文件 -linksource 以 HTML 格式生成源文件 -sourcetab 指定源中每个制表符占据的空格数 -keywords 使程序包, 类和成员信息附带 HTML 元标记 -stylesheetfile 用于更改生成文档的样式的文件 -docencoding 指定输出的字符编码

生成JavaDoc文档

标签:类加载器   boot   not   styles   less   offline   cte   ado   默认值   

原文地址:https://www.cnblogs.com/flyzt/p/14588264.html


评论


亲,登录后才可以留言!