常用Java注释标签
来源:互联网 发布:罗京 艾滋 知乎 编辑:程序博客网 时间:2024/06/13 11:01
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)
@author
(*多个作者使用多个@author标签标识,java doc中显示按输入时间顺序罗列。)
例:* @author Leo. Yao
@param
例:* @param str the String用来存放输出信息。
@return
例: * @return <code>true</code>执行成功;
* <code>false</code>执行失败.
@since JDK
适用范围:文件、类
例: * @since JDK1.6
@version
适用范围:文件、类、方法
例: * @version 1.0
@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
@throws
适用范围:方法
例: * @throws IOException If an input or output exception occurred
@deprecated
适用范围:文件、类、方法
@link
例:
/**
* @deprecated As of JDK 1.1, replaced by
* {@link #setBounds(int,int,int,int)}
*/
2 Java
* @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)
- 常用Java注释标签
- 常用Java注释标签
- Java注释常用标签实例
- 常用的Java注释标签
- 常用Java注释标签(Java comment tags)
- java 注释标签说明
- 【JAVA】3、常用代码注释
- 常用的CSS标签标记属性翻译注释
- java web开发常用标签
- java的jsp常用标签
- Java Jsp常用标签汇总
- 实用简约的JAVA注释标签-高手必备
- Javadoc注释标签语法
- Javadoc注释标签语法
- servlet标签注释
- Struts2 标签注释
- javadoc注释标签语法
- HTML5 <ruby>注释标签
- HDU 4273 Rescue && 3D凸包模板题
- qwt安装使用精华版
- C#学习路线图:C#经典编程220例(奋斗的小鸟)
- java io 输入输出流
- 驳斥《沙盒用于数据防泄密是重大技术原理性失误》
- 常用Java注释标签
- 设计模式:.NET并行编程(奋斗的小鸟)
- 使用WTSGetActiveConsoleSessionId()的VISTA服务与桌面交互
- Goldbach's Conjecture
- Android-添加menu
- 数据挖掘之朴素贝叶斯算法的实现
- java.lang.UnsatisfiedLinkError: ...Sample1.dll: Can't load IA 32-bit .dll on a AMD 64-bit platform
- 经典算法之不定方程问题
- netty 使用注意事项