文章插图
javadoc【javadoc】javadoc是Sun公司提供的一个技术，它从程式原始码中抽取类、方法、成员等注释形成一个和原始码配套的API帮助文档 。也就是说，只要在编写程式时以一套特定的标籤作注释，在程式编写完成后，通过Javadoc就可以同时形成程式的开发文档了 。
javadoc命令是用来生成自己API文档的，使用方式：使用命令行在目标档案所在目录输入javadoc +档案名称.java 。
基本介绍中文名：javadoc
外文名：javadoc
提供：Sun公司
性质：技术
@author 作者：作者标识
常用标记标籤说明JDK 1.1 doclet标準doclet标籤类型@author 作者作者标识√√包、 类、接口@version 版本号版本号√√包、 类、接口@param 参数名 描述方法的入参名及描述信息，如入参有特别要求，可在此注释 。√√构造函式、 方法@return 描述对函式返回值的注释√√方法@deprecated 过期文本标识随着程式版本的提升，当前API已经过期，仅为了保证兼容性依然存在，以此告之开发者不应再用这个API 。√√包、类、接口、值域、构造函式、 方法@throws异常类名构造函式或方法所会抛出的异常 。√构造函式、 方法@exception 异常类名同@throws 。√√构造函式、 方法@see 引用查看相关内容，如类、方法、变数等 。√√包、类、接口、值域、构造函式、 方法@since 描述文本API在什幺程式的什幺版本后开发支持 。√√包、类、接口、值域、构造函式、 方法{@link包.类#成员 标籤}连结到某个特定的成员对应的文档中 。√包、类、接口、值域、构造函式、 方法{@value}当对常量进行注释时，如果想将其值包含在文档中，则通过该标籤来引用常量的值 。√(JDK1.4)静态值域此外还有@serial、@serialField、@serialData、{@docRoot}、{@inheritDoc}、{@literal}、{@code} {@value arg}几个不常用的标籤，由于不常使用，我们不展开叙述，感兴趣的读者可以查看帮助文档 。命令格式Javadoc命令格式如下：javadoc [选项] [软体包名称] [源档案]其中选项有：-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<标誌> 直接将 <标誌> 传递给运行时系统