G-1020
🆓Warning
Always have a matching loop or block label.
Reason
Use a label directly in front of loops and nested anonymous blocks:
- To give a name to that portion of code and thereby self-document what it is doing.
- So that you can repeat that name with the
endstatement of that block or loop.
Example
Non-Compliant Example
declare
i integer;
co_min_value constant integer := 1;
co_max_value constant integer := 10;
co_increment constant integer := 1;
begin
<<prepare_data>>
begin
null;
end;
<<process_data>>
begin
null;
end;
i := co_min_value;
<<while_loop>>
while (i <= co_max_value)
loop
i := i + co_increment;
end loop;
<<basic_loop>>
loop
exit basic_loop when true;
end loop;
<<for_loop>>
for i in co_min_value..co_max_value
loop
sys.dbms_output.put_line(i);
end loop;
end;
/Issues
| Line | Column | Message |
|---|---|---|
| 10 | 4 | Missing prepare_data end label. |
| 15 | 4 | Missing process_data end label. |
| 22 | 8 | Missing while_loop end label. |
| 27 | 8 | Missing basic_loop end label. |
| 33 | 8 | Missing for_loop end label. |
Compliant Solution - ★★★★★
declare
i integer;
co_min_value constant integer := 1;
co_max_value constant integer := 10;
co_increment constant integer := 1;
begin
<<prepare_data>>
begin
null;
end prepare_data;
<<process_data>>
begin
null;
end process_data;
i := co_min_value;
<<while_loop>>
while (i <= co_max_value)
loop
i := i + co_increment;
end loop while_loop;
<<basic_loop>>
loop
exit basic_loop when true;
end loop basic_loop;
<<for_loop>>
for i in co_min_value..co_max_value
loop
sys.dbms_output.put_line(i);
end loop for_loop;
end;
/References
- similar to plsql:LoopUnlabeledEndCheck
The scope of plsql:LoopUnlabeledEndCheck is missing loop end labels.
- similar to plsql:LabelStartEndMatchLoopCheck
The scope of plsql:LabelStartEndMatchLoopCheck is mismatches of loop start and end labels.
- similar to plsql:LabelStartEndMatchBlockCheck
The scope of plsql:LabelStartEndMatchBlockCheck is mismatches of block start and end labels.
- similar to plsql:plsql:BlockUnlabeledEndCheck
The scope of plsql:plsql:BlockUnlabeledEndCheck is missing block end labels.
- same as Trivadis G-1020