java1.5中@Override还不能用在interface上,只能用在class上。给我们的代码注释带来了一定的烦恼。
为了表明一个方法是实现一个interface,我们可以使用{@inheritDoc}来标识,同时,该tag会把super type的注释复制下来。
public interface A {
/**
* F method.
* @param a para a.
* @param b para b.
* @return f(a,b).
* */
public int f(int a, int b);
}
class B implements A {
/**
* {@inheritDoc}
* */
public int f(int a, int b) {
return 0;
}
}
在生成的html中,我们可以看到B的方法注释完全复制自A.
public int f(int a,int b)
F method.
Specified by:
f in interface A
Parameters:
a - para a.
b - para b.
Returns:
f(a,b).
当然,我们有可能改变接口的约定(不推荐这么做),这时,可以只注释改变的注释元素。
/**
* {@inheritDoc}
* F method, compute sum.
* @param a a>=0
* @return a+b
* */
public int f(int a, int b) {
return 0;
}
这个的javadoc的结果为
f
public int f(int a,int b)
F method. F method, compute sum.
Specified by:
f in interface A
Parameters:
a - a>=0
b - para b.
Returns:
a+b
可以看到,方法的主体注释文本为两个主体注释的拼接,参数,返回值都可以覆盖掉接口的注释。
对于异常的注释的继承比较特殊:
若子类没有声明父类的异常,则父类的异常注释不会被继承。
子类只会继承它和父类共同声明的异常。
当然,异常的注释,子类可以覆盖掉父类的注释。
推荐的异常注释是子类列出所有的异常,如果父类也声明了该异常,则用
@throws IOException {@inheritDoc}
继承该异常的注释。
所有的注释继承都有拼接功能,如
* @return {@inheritDoc} a+b.
* @throws IOException {@inheritDoc} when file is missed.
返回值注释会继承父类的返回值注释,在加上新的注释。
异常注释会继承父类的异常注释,在加上新的注释。
分享到:
相关推荐
泛型是Java 1.5最重要的特性之一,允许在类、接口和方法中使用类型参数。泛型提高了代码的类型安全性和可读性,减少了类型转换的必要,并防止了运行时的ClassCastException。 2. **枚举(Enums)** Java 1.5引入...
在这个"最新JAVA1.5中文API"中,开发者可以找到全面的文档,帮助理解并利用这些新特性进行编程。 首先,让我们来探讨一些Java 1.5中的关键更新: 1. **泛型(Generics)**:这是Java 1.5最显著的变化之一,允许在...
泛型是JAVA 1.5中最引人注目的特性之一,它允许开发者在类、接口或方法中声明类型参数,从而在编译时提供类型安全检查,避免了运行时的类型转换错误。在JAVA 1.4及更早版本中,集合框架只能存储`Object`类型的元素,...
Java1.5API中文版(含前两次发布内容)
根据给定的信息,我们可以深入探讨Java 1.5中引入的泛型概念及其应用。本文将详细介绍以下几个方面: ### 1. 引言 #### 泛型简介 Java 1.5引入了泛型(Generics)的概念,这是一个重要的语言特性,它允许开发者在...
JRE1.5在Java的发展历程中具有里程碑意义,因为它引入了一系列显著的改进和新特性,对提升性能、增强安全性和优化开发流程产生了重大影响。 首先,JRE1.5,也被称为Java 5.0,引入了泛型(Generics)。泛型允许...
本资源提供的"适用于JAVA1.5+版本的json lib"是一套JSON处理的库,特别适合Java 1.5及以上版本的项目使用。其中包含以下几个关键的JAR文件: 1. **commons-collections-3.2.1.jar**:Apache Commons Collections是...
Java API 1.5,也被称为Java SE 5.0(Java Standard Edition 5.0),是Java发展历程中的一个重要里程碑,引入了许多创新特性和改进,为开发者提供了更强大的工具和功能。这个API文档包含了Java语言的全面参考资料,...
sun 标准中文java api
这些特性在 Java 1.5 中的引入,显著提升了代码的可读性、安全性和维护性,使得 Java 成为了一个更加现代化的编程语言。使用这些特性能够编写出更加高效、清晰的代码,避免了不必要的类型转换和潜在的运行时错误。
Java JDK,全称为Java Development ...虽然JDK1.5和1.6已经较旧,但它们仍然是学习Java历史和技术演进过程中的重要参考。如果你正在使用的是这些旧版本,确保了解其限制和已知问题,以便在必要时升级到更现代的版本。
java1.5 cn 3 java1.5 cn 3 java1.5 cn 3
【Java面向方面编程(AOP)】在Java 1.5版本中引入了面向方面的编程(Aspect-Oriented Programming,AOP)概念,这是一种设计模式,旨在解决程序中的横切关注点,如日志、事务管理、性能监控等,将这些关注点与核心...
在JDK1.5中,开发者可以在方法签名中使用省略号(...)表示可变参数。这允许方法接受任意数量的相同类型的参数,如: ```java public void printNumbers(int... nums) { // 代码块 } ``` 这个方法可以接收一个或多...
java1.5 cn 5 java1.5 cn 5 java1.5 cn 5
java1.5 cn 4 java1.5 cn 4 java1.5 cn 4
Java Api 1.5中文版本 分卷2 ,需要分卷1,一同才可以解压
BioJava1.5-docs.tar是BioJava 1.5版本的文档集合,包含了关于该项目的详细说明和API参考,是开发者理解和使用BioJava的重要资源。 在解压BioJava1.5-docs.tar后,主要会得到一个名为"doc"的文件夹,该文件夹内包含...
在"IBM_jdk1.5_Guide.pdf"这个文档中,很可能是IBM JDK 1.5的官方指南或开发者手册,它将详细阐述如何安装、配置和使用IBM JDK 1.5,以及如何在AIX环境下进行Java开发。而"www.pudn.com.txt"可能是下载资源的来源...
在 Java 中,枚举实例可以直接在这些场景中使用,而无需像对象那样依赖 `equals()` 或 `compareTo()` 方法。 4. 高效运行:枚举的运行效率应与基本类型的整数相当。在 Java 中,枚举类型在运行时的表现与基本类型...