java⽣成说明⽂档_javadoc⽣成说明⽂档JDK中可执⾏命令:javadoc和相关参数如下:
C:\Users\123>javadoc
javadoc: 错误 - 未指定程序包或类。
⽤法: 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                  递归复制⽂档⽂件⼦⽬录
java中split的用法-
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 输出编码名称
1、使⽤命令⽣成⽂档:
注意:需要使⽤参数:-encoding utf-8 -charset utf-8 对⽂档注释的中⽂进⾏编码指定,默认为本操作系统下的编码。
< -protected -splitindex -use-encoding utf-8 -charset utf-8
@C:\Users\123\AppData\Local\ -d C:\Users\123\Desktop
引⼊⽂件内容(C:\Users\123\AppData\Local\):
com.shu.secondsection
-sourcepath
"C:/Users/123/IdeaProjects/ThinkingInJava/src/main/resources;C:/Users/123/IdeaProjects/ThinkingInJava/src/main/java;C:/
2、使⽤IDE⼯具:(IntelliJ IDEA)
ntelliJ IDEA作为Java流⾏的编辑器, 其⽣成⼀些Javadoc会对中⽂乱码, 使⽤UTF-8编码即可. 这个常见的问题, 则需要⽣成时设置参数即可.
在 “Tools->Gerenate JavaDoc” ⾯版的 “Other command line arguments:” 栏⾥输⼊ “-encoding utf-8 -charset utf-8”.

版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。