`

java 文档注释

 
阅读更多

1 常用Java注释标签(Java comment tags)

 

@author  作者

 

@param  输入参数的名称  说明

 

@return 输出参数说明

 

@since JDK版本

 

@version 版本号

 

@see 链接目标

 

@throws 异常

 

@deprecated 解释

 

@link 链接地址

 

2 Java注释的使用顺序

 

3 简单常见的HTML嵌入

 

4 HTML嵌入注释范例

 

 

5 参考文档

 

 

 

1   常用Java注释标签(Java comment tags)

 

@author  作者

 

适用范围:文件、类、方法

 

(*多个作者使用多个@author标签标识,java doc中显示按输入时间顺序罗列。)

 

例:* @author Leo. Yao

 

 

@param  输入参数的名称  说明

 

适用范围:方法

 

例:* @param str the String用来存放输出信息。

 

 

@return 输出参数说明

 

适用范围:方法

 

例:     * @return    <code>true</code>执行成功;

 

  *                 <code>false</code>执行失败.

 

 

@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 only, required)

 

* @version     (classes and interfaces only, required. See footnote 1)

 

* @param       (methods and constructors only)

 

* @return      (methods only)

 

* @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嵌入

 

<P> 用于分段

 

<code>  标签用于表示计算机源代码或者其他机器可以阅读的文本内容。<code> 标签就是为软件代码的编写者设计的。包含在该标签内的文本将用等宽、类似电传打字机样式的字体(Courier)显示出来只应该在表示计算机程序源代码或者其他机器可以阅读的文本内容上使用 <code> 标签。虽然 <code> 标签通常只是把文本变成等宽字体,但它暗示着这段文本是源程序代码。将来的浏览器有可能会加入其他显示效果。例如,程序员的浏览器可能会寻找 <code> 片段,并执行某些额外的文本格式化处理,如循环和条件判断语句的特殊缩进等。

 

4 HTML嵌入注释范例

 

/**

 * 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();

    }

}

 

5 参考文档

 

官方文档:http://java.sun.com/j2se/1.3/docs/tooldocs/win32/javadoc.html

分享到:
评论

相关推荐

    java文档注释要求

    ### Java文档注释要求详解 #### 一、引言 在软件开发领域,编写高质量的代码不仅是技术实力的体现,更是职业素养的重要标志之一。其中,文档注释(JavaDoc Comments)作为源代码的一部分,对于提升项目的可维护性...

    myeclipse/eclipse设置java文档注释

    ### myEclipse/Eclipse 设置 Java 文档注释详解 #### 一、引言 在进行软件开发的过程中,良好的代码注释习惯对于提升代码可读性和维护性至关重要。特别是在团队协作中,规范化的文档注释能够帮助团队成员更快地理解...

    xiexu-doc-20230619-生成Java文档注释文件

    本文将深入探讨Java文档注释的重要性和使用方法,以及如何通过命令行工具生成Java文档。 Java注释有三种基本类型:单行注释(//)、多行注释(/*...*/)和文档注释(/**...*/)。其中,文档注释是Java特有的,主要...

    java文档注释模板(个性化设置,包括颜色设置)

    这个是java文档注释模板,使用myeclipse创建的,里面添加了基本颜色,只需导进到开发工具就可以了

    Java-文档注释例子

    本文将深入探讨Java文档注释的概念、语法以及如何使用它来提高代码的可读性和维护性。 一、Java文档注释的作用 1. 提供自动生成API文档:Java的Javadoc工具可以读取源代码中的文档注释,生成HTML格式的文档,方便...

    java注释规范文档

    本文详细介绍了Java文档注释的规范及其重要性。通过遵循这些规范,不仅可以提高代码的可读性和可维护性,还能极大地提高团队的开发效率。掌握好javadoc工具的使用,能够帮助我们轻松地生成高质量的文档,这对于大型...

    java注释模板

    eclipse中java类注释模板,有需要的朋友可以参考使用。

    Java注释全解文档

    本篇全解文档深入探讨了Java注释的各种类型及其在不同框架中的应用,如Hibernate、Spring以及SSH(Struts、Spring、Hibernate)框架。 首先,Java注释分为三种主要类型:单行注释、多行注释和Javadoc注释。单行注释...

    java编码规范及注释快捷键.doc

    - **类与接口声明**:包括文档注释、类或接口的声明本身、实现注释、成员变量、构造函数以及方法的声明和实现。 #### 三、注释规范 - **文档注释**:用于生成API文档,通常采用Javadoc格式,位于类或方法声明之前...

    Java的注释

    3. **文档注释(/\*\*...\*/)**:用于生成API文档。 #### 二、注释的重要性 良好的注释习惯能够帮助团队成员更好地理解代码逻辑,便于后续的代码维护和重构。此外,对于个人而言,良好的注释习惯也有助于自身能力...

    java的注释规范(单行注释、多行注释、分块注释)

    java 注释规范是 Java 开发过程中不可或缺的一部分,它的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。java 注释规范可以分为三种:单行注释、多行注释和分块注释...

    Java 文档注释

    Java 文档注释 Java 支持三种注释方式。前两种分别是 // 和 /* */,第三种被称作说明注释,它以 /** 开始,以 */结束。 说明注释允许你在程序中嵌入关于程序的信息。你可以使用 javadoc 工具软件来生成信息,并输出...

    各种注释方法

    * 这是Java文档注释 */ ``` #### Properties 文件注释 Properties文件用于存储配置信息,通常使用键值对的形式。在Properties文件中,可以使用`#`符号来进行注释: ```properties # 这是Properties文件注释 ```...

    Java代码注释率检查器.rar

    Java代码注释是编程实践中非常重要的一个环节,它有助于提高代码的可读性和维护性。注释能够解释代码的功能、用途以及实现逻辑,使得其他开发者能更快地理解代码,尤其在团队协作中更是不可或缺。本资源"Java代码...

    java代码注释模板

    3. Javadoc注释:以`/**`开始,`*/`结束,主要用于生成API文档,格式严谨,结构清晰: ```java /** * 这是一个Javadoc注释,用于描述类、方法或变量的功能和使用方式。 * @param 参数名 参数描述 * @return ...

    java源码注释翻译

    在Java中,注释主要有三种类型:单行注释(//...),多行注释(/*...*/)和文档注释(/**...*/)。其中,文档注释通常用于生成Javadoc,提供类、方法等的API文档。这个翻译工具特别关注的就是这种类型的注释,因为它...

    Java注释规范

    3. 文档注释:使用 / 和 */囲み的注释,用于生成 javadoc 文档。 注释规范: 1. 注释要简单明了,避免晦涩难懂的语言。 2. 边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。 3. 在必要的...

    注释模板,代码格式化模板

    在Java中,我们常常会见到如Javadoc样式注释,它为API文档提供详细说明。Eclipse IDE允许用户自定义这些模板,例如,你可以创建一个模板用于类注释,其中自动插入创建日期、作者信息等。 接下来,我们讨论代码格式...

    Java语言程序设计:第二章 Java语言语法基础.ppt

    Java 语言中有三种类型的注释:单行注释、多行注释和 Java 文档注释。单行注释以 // 开头,多行注释以 /* 和 */括起来,Java 文档注释以 / 和 */括起来,用于生成类和接口的 HTML 格式的帮助文档。 Java 语言中有八...

    java代码注释规范文档

    - **格式**:`/** 文档注释内容 */` - **应用场景**: - 为类、方法、字段等提供详细说明。 - 自动生成API文档。 **示例**: ```java /** * 这是一个示例类,用于演示Javadoc注释。 * * @author 张三 * @...

Global site tag (gtag.js) - Google Analytics