Conventions

Top  Previous  Next

 

The Conventions report area contains:

 

- Conventions (CONV1-CONV31)

 

This report contains several lists with identifiers that do not comply with conventions.

 

The choice of names for identifiers has a considerable influence on the ease of understanding and maintenance costs of your source code. Developers familiar with the coding standards can understand the code more easily if it follows general conventions.

 

CONV1-Ordinary types that do not start with "T"

CONV2-Exception types that do not start with "E"

CONV3-Pointer types that do not start with "P"

CONV4-Interface types that do not start with "I"

CONV5-Class fields that are not declared in the private section

 

CONV6-Class fields that are exposed by properties (read/write) but do not start with "F"

CONV7-Properties to method pointers that do not start with "On/Before/After"

CONV8-Functions that are exposed by properties (read) but do not start with "Get"

CONV9-Procedures that are exposed by properties (write) but do not start with "Set"

CONV10-Classes that have visible constructors with bad names

 

CONV11-Classes that have visible destructors with bad names

CONV12-Identifiers that have unsuitable names

CONV13-Multiple with-variables

CONV14-Property access methods that are not private/protected

CONV15-Hard to read identifier names

 

CONV16-Label usage

CONV17-Bad class visibility order

CONV18-Identifiers with numerals

CONV19-Local identifiers that "shadow" outer scope identifiers

CONV20-Local identifiers that "shadow" class members

 

CONV21-Class/member name collision

CONV22-Class fields that are not declared in the private/protected sections

CONV23-Class fields that do not start with "F"

CONV24-Value parameters that do not start with selected prefix

CONV25-Const parameters that do not start with selected prefix

 

CONV26-Out parameters that do not start with selected prefix

CONV27-Var parameters that do not start with selected prefix

CONV28-Old-style function result

CONV29-With statements

CONV30-Private can be changed to strict private

CONV31-Protected can be changed to strict protected

 

 

See also:

 

Reports

Alerts

Optimizations

Reductions