Javadoc的概念以及基本使用

Javadoc的概念以及基本使用

（一）Javadoc的概念

百科里是这么解释的：javadoc是Sun公司提供的一种技术，它从程序源代码中捕获类，方法，成员等注释形成一个和源代码配套的API帮助文档。作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。

简而言之，Javadoc中你写的的Java程序里每个方法，转变是做什么的注释，然后合成一个文档，可以查阅。

（二）Javadoc的基本使用

1.概要：

通常用一句或者一段话简要描述该类的作用，以英文句号作为结束。

Class comment 示例：
/**
 * A class representing a window on the screen.
 * For example:
 * <pre>
 *    Window win = new Window(parent);
 *    win.show();
 * </pre>
 *
 * @author  Sami Shaio
 * @version 1.13, 06/08/06
 * @see     java.awt.BaseWindow
 * @see     java.awt.Button
 */
class Window extends BaseWindow {
   ...
}

单行示例：

package org.springframework.util;
/**
 * Miscellaneous {@link String} utility methods.
 * 
 */
public abstract class StringUtils {
   ...
}

多行示例：

package java.lang;


/**
 * Class {@code Object} is the root of the class hierarchy.
 * Every class has {@code Object} as a superclass. All objects,
 * including arrays, implement the methods of this class.
 */
public class Object {
   ...
}

2.Javadoc标记

在这里插入图片描述

3.命令格式

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<标志> 直接将 <标志> 传递给运行时系统

参考博客：

Javadoc注释详解
Javadoc基本使用