常用的Java注释标签
1 常用Java注释标签（Java comment tags）
@author 作者
适用范围：文件、类、方法
（多个作者使用多个@author标签标识，java doc中显示按输入时间顺序罗列。）
例： @author Leo. Yao
@param 输入参数的名称 说明
适用范围：方法
例：* @param str the String用来存放输出信息。
@return 输出参数说明
适用范围：方法
例： * @return
@since JDK版本
用于标识编译该文件所需要的JDK环境。
适用范围：文件、类
例： @since JDK1.6
@version 版本号
用于标识注释对象的版本号
适用范围：文件、类、方法
例： * @version 1.0
@see 链接目标
表示参考。会在java 文档中生成一个超链接，链接到参考的类容。
用法：
@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
@throws 异常
标识出方法可能抛出的异常
适用范围：方法
例： * @throws IOException If an input or output exception occurred
@deprecated 解释
标识对象过期
适用范围：文件、类、方法
@link 链接地址
链接到一个目标，用法类似@see。但常放在注释的解释中形如{@link …}
例：
/
* @deprecated As of JDK 1.1, replaced by
{@link #setBounds(int,int,int,int)}
/
2 Java注释的使用顺序
* @author (classes and interfaces on
* @version (classes and interfaces on
* @param (methods and constructors on
* @return (methods on
* @exception (@throws is a synonym added in Javadoc 1.2)
* @see
* @since
* @serial (or @serialField or @serialData)
* @deprecated (see How and When To Deprecate APIs)
3 简单常见的HTML嵌入
4 HTML嵌入注释范例
/
* Graphics is the abstract base class for all graphics contexts
* which allow an application to draw on
* various devices or on
* A Graphics object encapsulates the state information needed
* for the various rendering operations that Java supports. This
* state information includes:
*
*
*
*
*
*
*
*
(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 imp
* covers a given rectangle will occupy 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 on
* 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
* @return
loaded and was painted successfully;
* @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 on
* 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 on
* referenced.
@see #dispose()
* @since 1.0
*/
public void finalize() {
dispose();
}
}
5 参考文档
官方文档：http://java.sun.com/j2se/1.3/docs/tooldocs/win32/javadoc.html
本文来自互联网用户投稿，文章观点仅代表作者本人，不代表本站立场，不承担相关法律责任。如若转载，请注明出处。 如若内容造成侵权/违法违规/事实不符，请点击【内容举报】进行投诉反馈！