Skip to content

Commit c9d5454

Browse files
Update maximum-nesting-depth.md
1 parent 5c6aa84 commit c9d5454

File tree

1 file changed

+3
-10
lines changed

1 file changed

+3
-10
lines changed

docs/checks/maximum-nesting-depth.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,24 @@
1-
# code pal for ABAP
2-
31
[code pal for ABAP](../../README.md) > [Documentation](../check_documentation.md) > [Nesting Depth Check](maximum-nesting-depth.md)
42

53
## Nesting Depth Check
64

75
### What is the Intent of the Check?
86

9-
The "Nesting Depth" Check counts the nesting depth level of a method, function-module, form-routine or module. A high value of nesting depth is an indicator that the source code is not readable anymore in a way that maintaining and extending the code can be done efficiently. In addition, the risk of introducing bugs is increased with a high nesting depth value.
7+
This check counts the nesting-depth level of a method, function-module, form-routine or module. A high value of nesting depth is an indicator that the source code might be difficult to read (no readability). Furthermore, maintaining and extending the code is also more difficult. In addition, the risk of introducing bugs is increased with a high nesting depth value.
108

119
### How does the check work?
1210

1311
The check verifies if the number of nested code blocks within a method, function module, form routine or module has reached/exceeded a defined threshold (configurable).
1412

15-
OBS.: The `TEST-SEAM` statement does not count to the level of nesting depth (it is ignored).
16-
17-
### Which attributes can be maintained?
18-
19-
![Attributes](./imgs/nesting_depth.png)
13+
REMARK: The `TEST-SEAM` statement does not count to the level of nesting depth (it is ignored).
2014

2115
### How to solve the issue?
2216

2317
Modularize the functionality into smaller blocks. This increases the readability and efficiency.
2418

2519
### What to do in case of exception?
2620

27-
You can suppress Code Inspector findings generated by this check using the pseudo comment `"#EC CI_NESTING`.
28-
The pseudo comment must be placed right after the `ENDMETHOD` statement.
21+
In exceptional cases, you can suppress this finding by using the pseudo comment `"#EC CI_NESTING` which should be placed right after the `ENDMETHOD` statement:
2922

3023
```abap
3124
METHOD method_name.

0 commit comments

Comments
 (0)