
Inline adoc files when they are included exactly once. Also fix language tags because this inlining gives us better information on what language the code is written in.
40 lines
630 B
Plaintext
40 lines
630 B
Plaintext
== Why is this an issue?
|
|
|
|
include::description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,text]
|
|
----
|
|
public double divide(int divisor, int dividend) {
|
|
return divisor/dividend;
|
|
}
|
|
|
|
public void doTheThing() {
|
|
int divisor = 15;
|
|
int dividend = 5;
|
|
|
|
double result = divide(dividend, divisor); // Noncompliant; operation succeeds, but result is unexpected
|
|
//...
|
|
}
|
|
----
|
|
|
|
|
|
=== Compliant solution
|
|
|
|
[source,text]
|
|
----
|
|
public double divide(int divisor, int dividend) {
|
|
return divisor/dividend;
|
|
}
|
|
|
|
public void doTheThing() {
|
|
int divisor = 15;
|
|
int dividend = 5;
|
|
|
|
double result = divide(divisor, dividend);
|
|
//...
|
|
}
|
|
----
|
|
|