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
1.2 KiB
Plaintext
61 lines
1.2 KiB
Plaintext
== Why is this an issue?
|
|
|
|
Nested ``++If++``, ``++Select++``, ``++For++``, ``++For Each++``, ``++While++``, ``++Do++``, and ``++Try++`` statements are key ingredients for making what's known as "Spaghetti code".
|
|
|
|
Such code is hard to read, refactor and therefore maintain.
|
|
|
|
=== Noncompliant code example
|
|
|
|
With the default threshold of 3:
|
|
|
|
[source,vbnet]
|
|
----
|
|
If condition1 ' Compliant - depth = 1
|
|
' ...
|
|
If condition2 ' Compliant - depth = 2
|
|
' ...
|
|
For i = 0 to 10 ' Compliant - depth = 3, not exceeding the limit
|
|
' ...
|
|
If condition4 ' Noncompliant - depth = 4
|
|
If condition5 ' Depth = 5, exceeding the limit, but issues are only reported on depth = 4
|
|
' ...
|
|
End If
|
|
Return
|
|
End If
|
|
Next
|
|
End If
|
|
End If
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
=== Parameters
|
|
|
|
.maximumNestingLevel
|
|
****
|
|
_INTEGER_
|
|
|
|
----
|
|
3
|
|
----
|
|
|
|
Maximum allowed control flow statement nesting depth.
|
|
****
|
|
|
|
|
|
include::../highlighting.adoc[]
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|