51369b610e
When an include is not surrounded by empty lines, its content is inlined on the same line as the adjacent content. That can lead to broken tags and other display issues. This PR fixes all such includes and introduces a validation step that forbids introducing the same problem again.
61 lines
956 B
Plaintext
61 lines
956 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,csharp]
|
|
----
|
|
public void Evaluate()
|
|
{
|
|
/* ... */
|
|
{ // Noncompliant - nested code block '{' ... '}'
|
|
int a = stack.pop();
|
|
int b = stack.pop();
|
|
int result = a + b;
|
|
stack.push(result);
|
|
}
|
|
/* ... */
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,csharp]
|
|
----
|
|
public void Evaluate()
|
|
{
|
|
/* ... */
|
|
StackAdd();
|
|
/* ... */
|
|
}
|
|
|
|
private void StackAdd()
|
|
{
|
|
int a = stack.pop();
|
|
int b = stack.pop();
|
|
int result = a + b;
|
|
stack.push(result);
|
|
}
|
|
----
|
|
|
|
=== Exceptions
|
|
|
|
The usage of a code block after a "case" is allowed for this rule.
|
|
|
|
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[]
|