开发者社区> usher.yue> 正文

javadoc的用法

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

编辑本段用于注释

  Java中有三种注释方法:
  javadoc

javadoc

1. //被注释语句
  2. /*被注释语句*/
  3. /**被注释语句*/
  其中第三种专为JavaDoc设计,可以被JDK内置的JavaDoc工具支持和处理。

编辑本段关键词列表

  @author 作者名
  @version 版本标识
  @parameter 参数及其意义
  @since 最早使用该方法/类/接口的JDK版本
  @return 返回值
  @throws 异常类及抛出条件
  @deprecated 引起不推荐使用的警告
  @see reference
  @override 重写

编辑本段用法

  javadoc [选项] [软件包名称] [源文件] [@file]
  -overview <文件> 读取 HTML 文件的概述文档
  -public 仅显示公共类和成员
  -protected 显示受保护/公共类和成员(默认)
  -package 显示软件包/受保护/公共类和成员
  -private 显示所有类和成员
  -help 显示命令行选项并退出
  -doclet <类> 通过替代 doclet 生成输出
  -docletpath <路径> 指定查找 doclet 类文件的位置
  -sourcepath <路径列表> 指定查找源文件的位置
  -classpath <路径列表> 指定查找用户类文件的位置
  -exclude <软件包列表> 指定要排除的软件包的列表
  -subpackages <子软件包列表> 指定要递归装入的子软件包
  -breakiterator 使用 BreakIterator 计算第 1 句
  -bootclasspath <路径列表> 覆盖引导类加载器所装入的
  类文件的位置
  -source <版本> 提供与指定版本的源兼容性
  -extdirs <目录列表> 覆盖安装的扩展目录的位置
  -verbose 输出有关 Javadoc 正在执行的操作的消息
  -locale <名称> 要使用的语言环境,例如 en_US 或 en_US_WIN
  -encoding <名称> 源文件编码名称
  -quiet 不显示状态消息
  -J<标志> 直接将 <标志> 传递给运行时系统

编辑本段通过标准

  javadoc

javadoc

  -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> 的包列表链接至位于
  档
  -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 的路径
  -charset <charset> 用于跨平台查看生成的文档的字符集
  -helpfile <file> 包含帮助链接所链接到的文件
  -linksource 以 HTML 格式生成源文件
  -sourcetab <tab length> 指定源中每个制表符占据的空格数
  -keywords 使包、类和成员信息附带HTML 元标记
  -stylesheetfile <path> 用于更改生成文档的样式的文件
  -docencoding <name> 输出编码名称

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
阿里云服务器安全组设置内网互通的方法
虽然0.0.0.0/0使用非常方便,但是发现很多同学使用它来做内网互通,这是有安全风险的,实例有可能会在经典网络被内网IP访问到。下面介绍一下四种安全的内网互联设置方法。 购买前请先:领取阿里云幸运券,有很多优惠,可到下文中领取。
18615 0
使用OpenApi弹性释放和设置云服务器ECS释放
云服务器ECS的一个重要特性就是按需创建资源。您可以在业务高峰期按需弹性的自定义规则进行资源创建,在完成业务计算的时候释放资源。本篇将提供几个Tips帮助您更加容易和自动化的完成云服务器的释放和弹性设置。
18665 0
使用NAT网关轻松为单台云服务器设置多个公网IP
在应用中,有时会遇到用户询问如何使单台云服务器具备多个公网IP的问题。 具体如何操作呢,有了NAT网关这个也不是难题。
34557 0
阿里云服务器如何登录?阿里云服务器的三种登录方法
购买阿里云ECS云服务器后如何登录?场景不同,大概有三种登录方式:
9065 0
使用SSH远程登录阿里云ECS服务器
远程连接服务器以及配置环境
12457 0
阿里云服务器ECS远程登录用户名密码查询方法
阿里云服务器ECS远程连接登录输入用户名和密码,阿里云没有默认密码,如果购买时没设置需要先重置实例密码,Windows用户名是administrator,Linux账号是root,阿小云来详细说下阿里云服务器远程登录连接用户名和密码查询方法
21539 0
阿里云服务器ECS登录用户名是什么?系统不同默认账号也不同
阿里云服务器Windows系统默认用户名administrator,Linux镜像服务器用户名root
13819 0
如何设置阿里云服务器安全组?阿里云安全组规则详细解说
阿里云安全组设置详细图文教程(收藏起来) 阿里云服务器安全组设置规则分享,阿里云服务器安全组如何放行端口设置教程。阿里云会要求客户设置安全组,如果不设置,阿里云会指定默认的安全组。那么,这个安全组是什么呢?顾名思义,就是为了服务器安全设置的。安全组其实就是一个虚拟的防火墙,可以让用户从端口、IP的维度来筛选对应服务器的访问者,从而形成一个云上的安全域。
17034 0
+关注
usher.yue
算法相关技术专家
431
文章
0
问答
文章排行榜
最热
最新
相关电子书
更多
OceanBase 入门到实战教程
立即下载
阿里云图数据库GDB,加速开启“图智”未来.ppt
立即下载
实时数仓Hologres技术实战一本通2.0版(下)
立即下载