16f6c0aecf
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.
64 lines
1.4 KiB
Plaintext
64 lines
1.4 KiB
Plaintext
== Why is this an issue?
|
|
|
|
Proper indentation is a simple and effective way to improve the code's readability. Consistent indentation among the developers within a team also reduces the differences that are committed to source control systems, making code reviews easier.
|
|
|
|
|
|
This rule raises an issue when indentation does not match the configured value. Only the first line of a badly indented section is reported.
|
|
|
|
=== Noncompliant code example
|
|
|
|
With an indent size of 2:
|
|
|
|
[source,java]
|
|
----
|
|
class Foo {
|
|
public int a;
|
|
public int b; // Noncompliant, expected to start at column 4
|
|
|
|
...
|
|
|
|
public void doSomething() {
|
|
if(something) {
|
|
doSomethingElse(); // Noncompliant, expected to start at column 6
|
|
} // Noncompliant, expected to start at column 4
|
|
}
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,java]
|
|
----
|
|
class Foo {
|
|
public int a;
|
|
public int b;
|
|
|
|
...
|
|
|
|
public void doSomething() {
|
|
if(something) {
|
|
doSomethingElse();
|
|
}
|
|
}
|
|
}
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
=== on 18 Nov 2016, 08:38:56 Tibor Blenessy wrote:
|
|
The parameter key is called ``++indentationLevel++`` in the current implementation. Changing the key would be a breaking change, so I am changing the RSPEC to match the implementation.
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|