2023-05-03 11:06:20 +02:00
== Why is this an issue?
2023-10-11 16:43:59 +02:00
Nested control flow statements ``++If++``, ``++Select++``, ``++For++``, ``++For Each++``, ``++While++``, ``++Do++``, and ``++Try++`` are often key ingredients in creating
what's known as "Spaghetti code". This code smell can make your program difficult to understand and maintain.
2021-02-02 15:02:10 +01:00
2023-10-11 16:43:59 +02:00
When numerous control structures are placed inside one another, the code becomes a tangled, complex web.
This significantly reduces the code's readability and maintainability, and it also complicates the testing process.
2020-06-30 12:47:33 +02:00
2023-10-11 16:43:59 +02:00
== How to fix it
2020-06-30 12:47:33 +02:00
2023-10-11 16:43:59 +02:00
=== Code examples
The following example demonstrates the behavior of the rule with the default threshold of 3 levels of nesting:
==== Noncompliant code example
2020-06-30 14:49:38 +02:00
2022-02-04 17:28:24 +01:00
[source,vbnet]
2020-06-30 12:47:33 +02:00
----
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
----
2021-06-02 20:44:38 +02:00
2021-06-03 09:05:38 +02:00
ifdef::env-github,rspecator-view[]
2021-09-20 15:38:42 +02:00
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
2023-05-25 14:18:12 +02:00
=== Parameters
.maximumNestingLevel
****
_INTEGER_
----
3
----
Maximum allowed control flow statement nesting depth.
****
2021-09-20 15:38:42 +02:00
include::../highlighting.adoc[]
2021-06-08 15:52:13 +02:00
'''
2021-06-02 20:44:38 +02:00
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
2023-06-22 10:38:01 +02:00
2021-06-03 09:05:38 +02:00
endif::env-github,rspecator-view[]