常用Java注释标签.doc

《常用Java注释标签.doc》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、常用Java注释标签（Java comment tags）@author  作者适用范围：文件、类、方法（*多个作者使用多个@author标签标识，java doc中显示按输入时间顺序罗列。）例：* @author Leo. Yao@param  输入参数的名称  说明 适用范围：方法例：* @param str the String用来存放输出信息。@return 输出参数说明适用范围：方法例：     * @return    true执行成功;  *                 false执行失败.@since 

2、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(

3、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#Constr

4、uctor(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 解释

5、标识对象过期适用范围：文件、类、方法@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 on

6、ly, 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)