G-2185

🆓

Warning

Avoid using overly short names for explicitly or implicitly declared identifiers.

Rule Details

Severity Level: Major
Quality Area: Maintainability
Fixing times: 1 mins
Local-easy
Database Support: OracleDB (v7.3.4 +)

Reason

You should ensure that the name you have chosen well defines its purpose and usage. While you can save a few keystrokes typing very short names, the resulting code is obscure and hard for anyone besides the author to understand.

Example

Non-Compliant Example

declare
   i integer;
   c constant integer := 1;
   e exception;
begin
   i := c;
   do_something(i);
exception
   when e then
      null;
end;
/

Issues

Line	Column	Message
2	4	Identifier i is less than 4 characters.
3	4	Identifier c is less than 4 characters.
4	4	Identifier e is less than 4 characters.

Compliant Solution - ★★★★★

declare
   l_sal_comm     integer;
   co_my_constant constant integer := 1;
   e_my_exception exception;
begin
   l_sal_comm := co_my_constant;
   do_something(l_sal_comm);
exception
   when e_my_exception then
      null;
end;
/

Parameters

Use parameters to customize the rule to your needs.

Parameter	Description	Default Value
MinLenOfIdentifier	Minimum number of characters for a literal. An issue is reported when using shorter identifiers.	4

References

same as Trivadis G-2185