rspec/rules/S1161/java/rule.adoc

43 lines
979 B
Plaintext
Raw Normal View History

2021-04-28 16:49:39 +02:00
Using the ``++@Override++`` annotation is useful for two reasons :
* It elicits a warning from the compiler if the annotated method doesn't actually override anything, as in the case of a misspelling.
* It improves the readability of the source code by making it obvious that methods are overridden.
2021-04-28 16:49:39 +02:00
== Noncompliant Code Example
----
class ParentClass {
public boolean doSomething(){...}
}
class FirstChildClass extends ParentClass {
public boolean doSomething(){...} // Noncompliant
}
----
2021-04-28 16:49:39 +02:00
== Compliant Solution
----
class ParentClass {
public boolean doSomething(){...}
}
class FirstChildClass extends ParentClass {
@Override
public boolean doSomething(){...} // Compliant
}
----
2021-04-28 16:49:39 +02:00
== Exceptions
This rule is relaxed when overriding a method from the ``++Object++`` class like ``++toString()++``, ``++hashCode()++``, ...
ifdef::rspecator-view[]
== Comments And Links
(visible only on this page)
include::comments-and-links.adoc[]
endif::rspecator-view[]