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

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

/*** 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;}
}

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

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

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

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

/**
* Gets the label of this button(建议)
*//**
* This method gets the label(不建议)
*/

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

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

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

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

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

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

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

把主要内容复制到最终生成的package-summary.html文件中
处理@see, @since, 或{@link}标记
把第一句话复制到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();}
}

from: http://www.cnblogs.com/boring09/p/4274893.html