JAVA文档注释
2015-11-06 00:00
381 查看
摘要: JAVA文档注释
http://www.runoob.com/java/java-documentation.html
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> 片段,并执行某些额外的文本格式化处理,如循环和条件判断语句的特殊缩进等。
http://www.runoob.com/java/java-documentation.html
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> 片段,并执行某些额外的文本格式化处理,如循环和条件判断语句的特殊缩进等。
相关文章推荐
- 递归练习----递归输出某个目录下的.java文件
- java对象中的表面类型与实际类型
- java之行——第一天
- 选择蜂窝教育Java培训 成就Java大牛梦想
- cxf集成到spring中发布restful webservice
- velocity与spring整合的配置、应用以及注意事项
- java中获取ServletContext常见方法
- JAVA游戏编程学习笔记(三)Java 2D游戏底层绘图框架
- 使用ant编译打包、部署简单的javaweb项目 --02
- java程序性能优化
- json学习笔记_02_java创建json数据
- 【MyEclipse】史上最快捷-配置注释模版的方法
- Dubbo与Zookeeper、SpringMVC整合和使用(负载均衡、容错)
- java入门程序100例学习笔记(007车牌号计算)
- scala与java的性能对比
- Hadoop — 使用Eclipse编译运行MapReduce程序(Hadoop2.6.0)
- Java程序中避免使用字符串拼装SQL语句的之解决方案⑴-properties属性文件的使用
- ubuntu 15,04安装jdk
- java validation(JSR 303 )
- 菜鸟猿大战java之线程深入接触