如何写Java文档注释(Java Doc Comments)

最新推荐文章于 2023-08-05 09:27:56 发布

Liuqz2009

最新推荐文章于 2023-08-05 09:27:56 发布

阅读量2.9k

点赞数 2

本文翻译自How to Write Doc Comments for the Javadoc Tool，但是精简了一些私以为不重要的东西

本文不讨论如何使用javadoc工具自动生成文档的方法，而是主要探讨应该如何去写文档注释

业余时间整理，难免有遗漏或错误，如有发现欢迎指正

转载请注明

文档注释概览

“文档注释”(Java Doc Comments)是专门为了用javadoc工具自动生成文档而写的注释，它是一种带有特殊功能的注释。

文档注释与一般注释的最大区别在于起始符号是/**而不是/*或//。

比如：

/**
* 这是文档注释
*/

/*
* 这是一般注释
*/

// 这是一般注释

在一些IDE（比如Eclipse）中，文档注释会以不同于普通注释的颜色高亮显示。

此外，文档注释只负责描述类(class)、接口(interface)、方法(method)、构造器(constructor)、成员字段(field)。相应地，文档注释必须写在类、接口、方法、构造器、成员字段前面，而写在其他位置，比如函数内部，是无效的文档注释。

文档注释采用HTML语法规则书写，支持HTML标记(tag)，同时也有一些额外的辅助标记。需要注意的是，这些标记不是给人看的（通常他们的可读性也不好），他们的作用是为了javadoc工具更好地生成最终文档。所以，虽然有些标记写起来麻烦且看着不直观，还是要老老实实按规矩写滴。

文档注释的基本内容

一个文档注释由两部分组成：

/**
* 描述部分(description) 
*
* 标记部分(block tags)
*/

描述部分自然不用多说，所谓的标记符号指的是@param, @return, @see之类的，相信只要看过开源java代码的话应该都见过。

下面是一个描述一个方法的文档注释的例子

/**
 * Returns an Image object that can then be painted on the screen. 
 * The url argument must specify an absolute {@link URL}. The name
 * argument is a specifier that is relative to the url argument. 
 * <p>
 * This method always returns immediately, whether or not the 
 * image exists. When this applet attempts to draw the image on
 * the screen, the data will be loaded. The graphics primitives 
 * that draw the image will incrementally paint on the screen. 
 *
 * @param url an absolute URL giving the base location of the image
 * @param name the location of the image, relative to the url argument
 * @return the image at the specified URL
 * @see Image
 */
public Image getImage(URL url, String name) {
    try {
        return getImage(new URL(url, name));
    } catch (MalformedURLException e) {
        return null;
    }
}

需要注意的几点：

1. 第一行以特殊的文档定界符 /** 开头

3. 在描述段落和标记段落之间空一行，描述段落和标记段落必须分开，不能揉在一起，描述段落必须在标记段落之前
4. 每一行注释都应该跟后面描述的类、方法等保持同样距离的缩进，比如这样就是错误的

class Image {

/**
* 没有跟下面的方法保持同样的缩进
*/
    public Image getImage(URL url, String name) {
        ...
    }
}

5. 从javadoc 1.4之后，除第一行和最后一行外，可以省略其他行的前导星号(*)，但是一般不这么做

描述部分(Description)

描述部分的第一行应该是一句对类、接口、方法等的简单描述，这句话最后会被javadoc工具提取并放在索引目录中。

怎么界定第一句话到哪结束了呢？答案是跟在第一个句号（英文标点）之后的tab、空行或行终结符规定了第一句的结尾。

例如下面这句注释，第一句的结尾是Prof.：

/**
* This is a simulation of Prof. Knuth's MIX computer.
*/

除了普通的文本之外，描述部分可以使用：

1. HTML语法标签，例如 xxx

2. javadoc规定的特殊标签，例如 {@link xxx} 。标签的语法规则是：{@标签名标签内容}

需要注意的地方：

1. 标签在有javadoc工具生成文档时会转化成特殊的内容，比如 {@link URL} 标签会被转化成指向URL类的超链接

2. 如果注释包含多段内容，段与段之间需要用 分隔，空行是没用的
3. 最后结尾行 */ 和起始行不同，这里只有一个星号
4. 为了避免一行过长影响阅读效果，务必将每行的长度限制在80个字符以内

5. 善用javadoc工具的复制机制避免不必要的注释：

如果一个方法覆盖了父类的方法或实现了接口种的方法，那么javadoc工具会在该注释里添加指向原始方法的链接，此外如果新方法没有注释，那么javadoc会把原始方法的注释复制一份作为其注释，但是如果新方法有注释了，就不会复制了。

注释风格：

1. 使用 <code>关键字</code> 来强调关键字，建议强调的内容有：java关键字、包名、类名、方法名、接口名、字段名、参数名等
2. 控制 {@link xxx} 的数量，太多的链接会使文档的可读性很差，因为读者总是跳来跳去。不要出现相同的链接，同样的链接只保留第一个；不要为java自带的内容或是常识性的内容提供链接
3. 描述一个方法时，应当只保留方法名字，不要附带方法的参数。比如有个方法是add(Object obj)，那么用add指代该方法即可，而不是add(Object obj)
4. 英文注释可以是短语也可以是句子。如果是句子，首字母要大写，如果是短语，首字母小写。
5. 英文注释使用第三人称，而不是第二人称。比如：

/**
* Gets the label(建议) 
*/

/**
* Get the label(不建议)
*/

6. 方法的注释应该以动词或动词词组开头，因为方法是一个动作。比如：

/**
* Gets the label of this button(建议)
*/

/**
* This method gets the label(不建议)
*/

7. 当描述类、接口、方法这类的概念时，可以不用指名"类"、"接口"、"方法"这些词语，比如：

/**
* A button label (建议)
*/

/**
* This field is a button label (不建议)
*/

8. 英文使用this而不是the指代当前类，比如：

/**
* Gets the toolkit for this component (建议)
*/

/**
* Gets the toolkit for the component (不建议)
*/

9. API名应该是能够简单自我说明的，如果文档注释只是简单重复API的名称还不如没有文档，所以文档注释应该至少提供一些额外信息，否则干脆不要注释
10. 英文注释避免拉丁风格的缩写。比如使用"also knwon as"而不是"aka"，使用"that is"或"to be specific"而不是"i.e."，使用"for example"而不是"e.g."，使用"in other words"或"namely"而不是"viz."

标记部分(Tag)

标记部分跟在描述部分之后，且前面必须有一个空行间隔

常见标记:

1. @author 作者，没有特殊格式要求，名字或组织名称都可以
2. @version 软件版本号（注意不是java版本号），没有特殊格式要求
3. @param 方法参数，格式为： @param 参数名称参数描述

可以在参数描述中说明参数的类型
可以在参数名称和参数描述之间添加额外的空格来对齐
破折号或其他标点符号不能出现在参数描述之外的地方

4. @return 方法返回值，格式为： @return 返回值描述，如果方法没有返回值就不要写@return
5. @deprecated 应该告诉用户这个API被哪个新方法替代了，随后用 @see 标记或 {@link} 标记指向新API，比如：

/**
* @deprecated As of JDK 1.1, replaced by
* {@link #setBounds(int,int,int,int)}
*/

6. @throws （或 @exception ）包含方法显式抛出的检查异常(Checked Exception)，至于非显示抛出的其他异常(Unchecked Exception)，除非特别有必要，否则就别写了。一个原则就是，只记录可控的问题，对于不可控的或不可预测的问题，不要往上面写。

检查异常：在try语法块中触发，在catch块中捕获的异常，这些异常会由编译器在编译阶段检查并强制程序员处理
非检查异常：包括运行时异常(RuntimeException)和错误(Error)。

7. 自定义标记

注释风格：
1. 按照如下顺序提供标记

@author（只出现在类和接口的文档中）
@version（只出现在类和接口的文档中）
@param（只出现在方法或构造器的文档中）
@return（只出现在方法中）
@exception（从java1.2之后也可以使用@thrown替代）
@see
@since
@serial（也可以使用@serialField或@serialData替代）
@deprecated

此外，如果有多个相同标记，也要注意顺序：

多个@author标记，应该按照时间顺序排列，即原作者应该排在第一个位置
多个@param标记，应该按照参数定义的顺序排列
多个@exception（或是@thrown）应该按照异常的字母顺序排列
多个@see标记，应该按照注释的逻辑顺序排列，即从最近的到最远的，从最具体的到最一般的

2. 必须包含的标记

如果方法有参数，@param标记必须包含，而且每个对应一个参数
如果方法有返回值，@return标记必须包含

其他注释

1. 包级别的文档注释
从java1.2起允许包级别的文档注释，用以描述包信息。每个包都可以有自己的包文档注释，这些注释被写在叫package.html的单独文件中，并且放至于与源码(*.java)相同的路径下，注意，一定不能单独放置在其他路径。
javadoc工具按照以下流程处理package.html:

把主要内容复制到最终生成的package-summary.html文件中
处理@see, @since, 或{@link}标记
把第一句话复制到javadoc的索引中

在包注释主要介绍一下这个包大致是做什么用的、背景信息、在使用方面需要注意的地方等等信息

2. 匿名、内部类的文档注释
javadoc不会提取内部类的文档注释，所以如果想要在最终生成的文档中包含内部类的信息，方法就是——写在外部类的文档注释里。。

一个复杂的文档注释例子

/**
 * Graphics is the abstract base class for all graphics contexts
 * which allow an application to draw onto components realized on
 * various devices or onto off-screen images.
 * A Graphics object encapsulates the state information needed
 * for the various rendering operations that Java supports. This
 * state information includes:
 * <ul>
 * <li>The Component to draw on
 * <li>A translation origin for rendering and clipping coordinates
 * <li>The current clip
 * <li>The current color
 * <li>The current font
 * <li>The current logical pixel operation function (XOR or Paint)
 * <li>The current XOR alternation color
 * (see <a href="#setXORMode">setXORMode</a>)
 * </ul>
 * <p>
 * Coordinates are infinitely thin and lie between the pixels of the
 * output device.
 * Operations which draw the outline of a figure operate by traversing
 * along the infinitely thin path with a pixel-sized pen that hangs
 * down and to the right of the anchor point on the path.
 * Operations which fill a figure operate by filling the interior
 * of the infinitely thin path.
 * Operations which render horizontal text render the ascending
 * portion of the characters entirely above the baseline coordinate.
 * <p>
 * Some important points to consider are that drawing a figure that
 * covers a given rectangle will occupy one extra row of pixels on
 * the right and bottom edges compared to filling a figure that is
 * bounded by that same rectangle.
 * Also, drawing a horizontal line along the same y coordinate as
 * the baseline of a line of text will draw the line entirely below
 * the text except for any descenders.
 * Both of these properties are due to the pen hanging down and to
 * the right from the path that it traverses.
 * <p>
 * All coordinates which appear as arguments to the methods of this
 * Graphics object are considered relative to the translation origin
 * of this Graphics object prior to the invocation of the method.
 * All rendering operations modify only pixels which lie within the
 * area bounded by both the current clip of the graphics context
 * and the extents of the Component used to create the Graphics object.
 * 
 * @author Sami Shaio
 * @author Arthur van Hoff
 * @version %I%, %G%
 * @since 1.0
 */
public abstract class Graphics {

    /** 
     * Draws as much of the specified image as is currently available
     * with its northwest corner at the specified coordinate (x, y).
     * This method will return immediately in all cases, even if the
     * entire image has not yet been scaled, dithered and converted
     * for the current output device.
     * <p>
     * If the current output representation is not yet complete then
     * the method will return false and the indicated 
     * {@link ImageObserver} object will be notified as the
     * conversion process progresses.
     *
     * @param img the image to be drawn
     * @param x the x-coordinate of the northwest corner
     * of the destination rectangle in pixels
     * @param y the y-coordinate of the northwest corner
     * of the destination rectangle in pixels
     * @param observer the image observer to be notified as more
     * of the image is converted. May be 
     * <code>null</code>
     * @return <code>true</code> if the image is completely 
     * loaded and was painted successfully; 
     * <code>false</code> otherwise.
     * @see Image
     * @see ImageObserver
     * @since 1.0
     */
    public abstract boolean drawImage(Image img, int x, int y, 
                                      ImageObserver observer);


    /**
     * Dispose of the system resources used by this graphics context.
     * The Graphics context cannot be used after being disposed of.
     * While the finalization process of the garbage collector will
     * also dispose of the same system resources, due to the number
     * of Graphics objects that can be created in short time frames
     * it is preferable to manually free the associated resources
     * using this method rather than to rely on a finalization
     * process which may not happen for a long period of time.
     * <p>
     * Graphics objects which are provided as arguments to the paint
     * and update methods of Components are automatically disposed
     * by the system when those methods return. Programmers should,
     * for efficiency, call the dispose method when finished using
     * a Graphics object only if it was created directly from a
     * Component or another Graphics object.
     *
     * @see #create(int, int, int, int)
     * @see #finalize()
     * @see Component#getGraphics()
     * @see Component#paint(Graphics)
     * @see Component#update(Graphics)
     * @since 1.0
     */
    public abstract void dispose();

    /**
     * Disposes of this graphics context once it is no longer 
     * referenced.
     *
     * @see #dispose()
     * @since 1.0
     */
    public void finalize() {
        dispose();
    }
}

转自：http://www.cnblogs.com/boring09/p/4274893.html

一. Java 文档

通常这种注释的多行写法如下：

/**
* .........
* .........
*/

javadoc -d 文档存放目录 -author -version 源文件名.java
这条命令编译一个名为 “源文件名.java”的 java 源文件，并将生成的文档存放在“文档存放目录”指定的目录下，生成的文档中 index.html 就是文档的首页。-author 和 -version 两个选项可以省略。

二. 文档注释的格式

1. 文档和文档注释的格式化

生成的文档是 HTML 格式，而这些 HTML 格式的标识符并不是 javadoc 加的，而是我们在写注释的时候写上去的。
比如，需要换行时，不是敲入一个回车符，而是写入 ，如果要分段，就应该在段前写入 。
文档注释的正文并不是直接复制到输出文件 (文档的 HTML 文件)，而是读取每一行后，删掉前导的 * 号及 * 号以前的空格，再输入到文档的。如

/**
 * This is first line. <br>
 ***** This is second line. <br>
  This is third line.
 */

2. 文档注释的三部分
先举例如下

/**
 * show 方法的简述.
 * <p>show 方法的详细说明第一行<br>
 * show 方法的详细说明第二行
 * @param b true 表示显示，false 表示隐藏
 * @return 没有返回值
 */
public void show(boolean b) {
    frame.show(b);
}

第一部分是简述。文档中，对于属性和方法都是先有一个列表，然后才在后面一个一个的详细的说明
简述部分写在一段文档注释的最前面，第一个点号 (.) 之前 (包括点号)。换句话说，就是用第一个点号分隔文档注释，之前是简述，之后是第二部分和第三部分。

第二部分是详细说明部分。该部分对属性或者方法进行详细的说明，在格式上没有什么特殊的要求，可以包含若干个点号。
* show 方法的简述.
* show 方法的详细说明第一行 
* show 方法的详细说明第二行

简述也在其中。这一点要记住了

第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。
* @param b true 表示显示，false 表示隐藏
* @return 没有返回值

三. 使用 javadoc 标记
javadoc 标记由“@”及其后所跟的标记类型和专用注释引用组成
javadoc 标记有如下一些：

@author 标明开发该类模块的作者
@version 标明该类模块的版本
@see 参考转向，也就是相关主题
@param 对方法中某参数的说明
@return 对方法返回值的说明
@exception 对方法可能抛出的异常进行说明

@author 作者名
@version 版本号

其中，@author 可以多次使用，以指明多个作者，生成的文档中每个作者之间使用逗号 (,) 隔开。@version 也可以使用多次，只有第一次有效

使用 @param、@return 和 @exception 说明方法
这三个标记都是只用于方法的。@param 描述方法的参数，@return 描述方法的返回值，@exception 描述方法可能抛出的异常。它们的句法如下：
@param 参数名参数说明
@return 返回值说明
@exception 异常类名说明

四. javadoc 命令
用法：
　　

javadoc [options] [packagenames] [sourcefiles]

选项：

-public 仅显示 public 类和成员
-protected 显示 protected/public 类和成员 (缺省)
-package 显示 package/protected/public 类和成员
-private 显示所有类和成员
-d <directory> 输出文件的目标目录
-version 包含 @version 段
-author 包含 @author 段
-splitindex 将索引分为每个字母对应一个文件
-windowtitle <text> 文档的浏览器窗口标题

javadoc 编译文档时可以给定包列表，也可以给出源程序文件列表。例如在 CLASSPATH 下有两个包若干类如下：

　　fancy.Editor
　　fancy.Test
　　fancy.editor.ECommand
　　fancy.editor.EDocument
　　fancy.editor.EView

可以直接编译类：
javadoc fancy\Test.java fancy\Editor.java fancy\editor\ECommand.java fancy\editor\EDocument.java fancy\editor\EView.java

也可以是给出包名作为编译参数，如：javadoc fancy fancy.editor
可以自己看看这两种方法的区别

到此为止javadoc就简单介绍完了，想要用好她还是要多用，多参考标准java代码
Java代码规范
--注释

@author LEI

@version 1.10 2005-09-01
1 注释文档的格式

注释文档将用来生成HTML格式的代码报告，所以注释文档必须书写在类、域、构造函数、方法、定义之前。注释文档由两部分组成——描述、块标记。

例如：

/**
 * The doGet method of the servlet.
 * This method is called when a form has its tag value method equals to get.
 *
 * @param request
 * the request send by the client to the server
 * @param response
 * the response send by the server to the client
 * @throws ServletException
 * if an error occurred
 * @throws IOException
 * if an error occurred
 */

public void doGet (HttpServletRequest request, HttpServletResponse response)
                  throws ServletException, IOException {
    doPost(request, response);
}

前两行为描述，描述完毕后，由@符号起头为块标记注视。
2 注释的种类
2.1 文件头注释

文件头注释以 /*开始，以*/结束，需要注明该文件创建时间，文件名，命名空间信息。

例如：

/*
 * Created on 2005-7-2
 * /

2.2 类、接口注释

类、接口的注释采用 /** … */，描述部分用来书写该类的作用或者相关信息，块标记部分必须注明作者和版本。

例如：

/**Title: XXXX DRIVER 3.0
 *Description: XXXX DRIVER 3.0
 *Copyright: Copyright (c) 2003
 *Company:XXXX有限公司
 *
 * @author Java Development Group
 * @version 3.0
 */

例如：

/**
 * A class representing a window on the screen.
 * For example:
 *
 * Window win = new Window(parent);
 * win.show();
 *
 *
 * @author Sami Shaio
 * @version %I%, %G%
 * @see java.awt.BaseWindow
 * @see java.awt.Button
 */

class Window extends BaseWindow {

...

}

2.3 构造函数注释

构造函数注释采用 /** … */，描述部分注明构造函数的作用，不一定有块标记部分。

例如：

/**
 * 默认构造函数
 */

又例如：

/**
 * 带参数构造函数,初始化模式名,名称和数据源类型
 *
 * @param schema
 * Ref 模式名
 * @param name
 * Ref 名称
 * @param type
 * byVal 数据源类型
 */

2.4 域注释

域注释可以出现在注释文档里面，也可以不出现在注释文档里面。用/** … */的域注释将会被认为是注释文档热出现在最终生成的HTML报告里面，而使用/* … */的注释会被忽略。

例如：

/* 由于triger和表用一个DMSource，所以要区分和表的迁移成功标记 */
boolean isTrigerSuccess = false;

又例如：

/** 由于triger和表用一个DMSource，所以要区分和表的迁移成功标记 */
boolean isTrigerSuccess = false;

再例如：

/**
 * The X-coordinate of the component.
 *
 * @see #getLocation()
 */
int x = 1263732;

2.5 方法注释
方法注释采用 /** … */，描述部分注明方法的功能，块标记部分注明方法的参数，返回值，异常等信息。例如：

/**
 * 设置是否有外码约束
 *
 * @param conn
 * Connection 与数据库的连接
 */

2.6 定义注释
规则同域注释。

3 注释块标记
3.1 标记的顺序

块标记将采用如下顺序：

…
*
* @param (classes, interfaces, methods and constructors only)
* @return (methods only)
* @exception (@throws is a synonym added in Javadoc 1.2)
* @author (classes and interfaces only, required)
* @version (classes and interfaces only, required. See footnote 1)
* @see
* @since
* @serial (or @serialField or @serialData)
* @deprecated (see How and When To Deprecate APIs)
* …

一个块标记可以根据需要重复出现多次，多次出现的标记按照如下顺序：

@author 按照时间先后顺序（chronological）
@param 按照参数定义顺序（declaration）
@throws 按照异常名字的字母顺序（alphabetically）
@see 按照如下顺序：
@see #field
@see #Constructor(Type, Type...)
@see #Constructor(Type id, Type id...)
@see #method(Type, Type,...)
@see #method(Type id, Type, id...)
@see Class
@see Class#field
@see Class#Constructor(Type, Type...)
@see Class#Constructor(Type id, Type id)
@see Class#method(Type, Type,...)
@see Class#method(Type id, Type id,...)
@see package.Class
@see package.Class#field
@see package.Class#Constructor(Type, Type...)
@see package.Class#Constructor(Type id, Type id)
@see package.Class#method(Type, Type,...)
@see package.Class#method(Type id, Type, id)
@see package

3.2 标记介绍
3.2.1 @param标记

@param后面空格后跟着参数的变量名字（不是类型），空格后跟着对该参数的描述。

在描述中第一个名字为该变量的数据类型，表示数据类型的名次前面可以有一个冠词如：a,an,the。如果是int类型的参数则不需要注明数据类型。例如：

…
* @param ch the char 用用来……
* @param _image the image 用来……
* @param _num 一个数字……
…

对于参数的描述如果只是一短语，最好不要首字母大写，结尾也不要句号。
对于参数的描述是一个句子，最好不要首字母大写，如果出现了句号这说明你的描述不止一句话。如果非要首字母大写的话，必须用句号来结束句子。（英文的句号）

公司内部添加ByRef和ByVal两个标记，例如：

* @param _image the image ByRef 用来……

说明该参数是引用传递（指针），ByVal可以省略，表示是值传递。

3.2.2 @return标记
返回为空（void）的构造函数或者函数，@return可以省略。
如果返回值就是输入参数，必须用与输入参数的@param相同的描述信息。
必要的时候注明特殊条件写的返回值。

3.2.3 @throws 标记
@throws以前使用的是@exception。
@throws的内容必须在函数的throws部分定义。

3.2.4 @author标记
类注释标记。
函数注释里面可以不出现@author。

3.2.5 @version
类注释标记。
函数注释里面可以不出现@version

3.2.6 @since
类注释标记。
标明该类可以运行的JDK版本
例如：
@since JDK1.2

3.2.7 @deprecated
由于某种原因而被宣布将要被废弃的方法。

/**
 * @deprecated As of JDK 1.1, replaced by
 * setBounds
 * @see #setBounds(int,int,int,int)
 */

3.2.8 @link标记
语法：{@link package.class#member label}
Label为链接文字。
package.class#member将被自动转换成指向package.class的member文件的URL。

4 HTML代码的使用
在注释描述部分可以使用HTML代码。
…
表示段落
* ….
表示自动标号

5 注释示例

/**
 * Graphics is the abstract base class for all graphics contexts
 * which allow an application to draw onto components realized on
 * various devices or onto off-screen images.
 * A Graphics object encapsulates the state information needed
 * for the various rendering operations that Java supports. This
 * state information includes:
 *
 * The Component to draw on
 * A translation origin for rendering and clipping coordinates
 * The current clip
 * The current color
 * The current font
 * The current logical pixel operation function (XOR or Paint)
 * The current XOR alternation color
 * (see setXORMode)
 *
 *
 * Coordinates are infinitely thin and lie between the pixels of the
 * output device.
 * Operations which draw the outline of a figure operate by traversing
 * along the infinitely thin path with a pixel-sized pen that hangs
 * down and to the right of the anchor point on the path.
 * Operations which fill a figure operate by filling the interior
 * of the infinitely thin path.
 * Operations which render horizontal text render the ascending
 * portion of the characters entirely above the baseline coordinate.
 *
 * Some important points to consider are that drawing a figure that
 * covers a given rectangle will occupy one extra row of pixels on
 * the right and bottom edges compared to filling a figure that is
 * bounded by that same rectangle.
 * Also, drawing a horizontal line along the same y coordinate as
 * the baseline of a line of text will draw the line entirely below
 * the text except for any descenders.
 * Both of these properties are due to the pen hanging down and to
 * the right from the path that it traverses.
 *
 * All coordinates which appear as arguments to the methods of this
 * Graphics object are considered relative to the translation origin
 * of this Graphics object prior to the invocation of the method.
 * All rendering operations modify only pixels which lie within the
 * area bounded by both the current clip of the graphics context
 * and the extents of the Component used to create the Graphics object.
 *
 * @author Sami Shaio
 * @author Arthur van Hoff
 * @version %I%, %G%
 * @since 1.0
 */

public abstract class Graphics {

  /**
   * Draws as much of the specified image as is currently available
   * with its northwest corner at the specified coordinate (x, y).
   * This method will return immediately in all cases, even if the
   * entire image has not yet been scaled, dithered and converted
   * for the current output device.
   *
   * If the current output representation is not yet complete then
   * the method will return false and the indicated
   * {@link ImageObserver} object will be notified as the
   * conversion process progresses.
   *
   * @param img the image to be drawn
   * @param x the x-coordinate of the northwest corner
   * of the destination rectangle in pixels
   * @param y the y-coordinate of the northwest corner
   * of the destination rectangle in pixels
   * @param observer the image observer to be notified as more
   * of the image is converted. May be
   * null
   * @return true if the image is completely
   * loaded and was painted successfully;
   * false otherwise.
   * @see Image
   * @see ImageObserver
   * @since 1.0
   */
  public abstract boolean drawImage(Image img, int x, int y, ImageObserver observer);

  /**
   * Dispose of the system resources used by this graphics context.
   * The Graphics context cannot be used after being disposed of.
   * While the finalization process of the garbage collector will
   * also dispose of the same system resources, due to the number
   * of Graphics objects that can be created in short time frames
   * it is preferable to manually free the associated resources
   * using this method rather than to rely on a finalization
   * process which may not happen for a long period of time.
   *
   * Graphics objects which are provided as arguments to the paint
   * and update methods of Components are automatically disposed
   * by the system when those methods return. Programmers should,
   * for efficiency, call the dispose method when finished using
   * a Graphics object only if it was created directly from a
   * Component or another Graphics object.
   *
   * @see #create(int, int, int, int)
   * @see #finalize()
   * @see Component#getGraphics()
   * @see Component#paint(Graphics)
   * @see Component#update(Graphics)
   * @since 1.0
   */

  public abstract void dispose();

  /**
   * Disposes of this graphics context once it is no longer
   * referenced.
   *
   * @see #dispose()
   * @since 1.0
   */
  public void finalize() {
    dispose();
  }

}

转自：http://kelaocai.iteye.com/blog/22782