rspec/rules/S109/java/rule.adoc

49 lines
849 B
Plaintext
Raw Normal View History

2020-06-30 10:16:44 +02:00
include::../description.adoc[]
=== Exceptions
This rule ignores ``++hashCode++`` methods.
include::../how-to-fix-it.adoc[]
=== Code examples
==== Noncompliant code example
2020-06-30 10:16:44 +02:00
[source,java,diff-id=1,diff-type=noncompliant]
2020-06-30 10:16:44 +02:00
----
public static void doSomething() {
for (int i = 0; i < 4; i++) { // Noncompliant, 4 is a magic number
...
}
2020-06-30 10:16:44 +02:00
}
----
==== Compliant solution
2020-06-30 10:16:44 +02:00
[source,java,diff-id=1,diff-type=compliant]
2020-06-30 10:16:44 +02:00
----
public static final int NUMBER_OF_CYCLES = 4;
public static void doSomething() {
for (int i = 0; i < NUMBER_OF_CYCLES ; i++) { // Compliant
2020-06-30 10:16:44 +02:00
...
}
}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]