The Code Checker tool performs a scan of the project declarations and programs, in order to check conformity to a set of rules, motivated by integrity, safety and portability of the code. It is run from the "Code Checker" tab of the Output window.

Use the "Settings" button to select/configure the rules to be checked for violations.

Use the "Scan" button to start analysis. The project must be compiled without errors before being checked.

Double-click on a violation report line in the output enables you to navigate to the corresponding location of the source code.

Use commands of the contextual popup menu to copy or export the report.

Note: an option is available in the "Compiler" section of the "Project Settings" box to systematically run the Code Checker after any successful build.

Rules configuration

Use the "Configure" button to select and configure rules to be checked. This is also available from the main tab of the "Project Settings" box. Rules are shown in a tree including check boxes. Unchecked rules will be skipped during scan. Double-click on a rule to configure it.

You can select for each rule a severity level: "Not checked" or "Info" or "Warning" or "Error" or "Fatal". You can also enter for each rule a text reference that will be displayed in reports.

For rules referring to metrics (e.g. name length) you can enter a minimum and maximum value.

For rules concerning variables, you can specify a filter based on the "User's group" column of the variable editor: either check only in some user's groups, or check except in some user's groups. Please enter one user's group name per line

For rule 1.4, you have to enter in the "Data" box the list of forbidden names. Please enter one name per line.

In addition the rules configuration box enables you to export or import the configuration as XML file.

Rules

Default level = ERROR

Accept filtering by user’s group

All I/O board channels ("%..." variables created from the IO board editor) must have a readable alias defined in the variable editor. The "%..." names cannot be used in programs. Programs must always refer to aliases.

Default level = WARNING

Accept filtering by user’s group

Aliases of I/O board channels should not reflect the hardware location. For instance an alias for channel "%IX0.1" cannot be "DI0_1".

Default level = INFO

Accept filtering by user’s group in case of variables

Minimum and maximum values configurable

This applies to any declared variable or POU.

Default level = WARNING

Accept filtering by user’s group in case of variables

Data = list of forbidden names, separated by comas.

The dummy variables used during debugging should be removed from the final project. The user should enter the list of forbidden names for this rule.

Default level = ERROR

Accept filtering by user’s group in case of variables

The Workbench Studio proposes an option in order to accept variable names not compliant with the IEC standard (with punctuation, accents, spaces…). This option should not be used. Symbols of all variables and POUs are checked.

Default level = FATAL

Accept filtering by user’s group in case of variables

Reserved keywords from the IEC standard should not be used for naming variables, whatever is the programming language. For instance, the name "STEP" cannot be used.

Default level = WARNING

Does not accept filtering by user’s group

In the "POU Information" box, the items "Author", "Security Class" and "Project No" must be filled.

Default level = INFO

Accept filtering by user’s group in case of variables

When a variable is used in programs, it must have exactly the same case as its declared name.

Default level = ERROR

Accept filtering by user’s group in case of variables

This applies to all declared variables and POUs.

Default level = ERROR

Accept filtering by user’s group in case of variables

Minimum and maximum values configurable for the length

This applies to all declared variables and POUs.

Default level = WARNING

Accept filtering by user’s group in case of variables

Minimum value configurable as percent

This is the percentage of comments entered within the code of POU, whatever is the programming language. This percentage is tested individually for each POU and applies only to the code. Comments entered for local variables are not counted here.

Default level = WARNING

Accept filtering by user’s group in case of variables

Minimum value configurable as percent

Characters with ASCII code greater than 127 (accents, special characters) should not be used in comments. This applies to both declared objects and comments entered in POUs.

Default level = FATAL for IL – NOT CHECKED for others

Does not accept filtering by user’s group

This rule is derived for: IL, ST, LD, FBD and SFC languages

Default level = FATAL for IL – NOT CHECKED for others

Does not accept filtering by user’s group

This rule is derived for: IL, ST, LD, FBD and SFC languages

Default level = FATAL for IL – NOT CHECKED for others

Does not accept filtering by user’s group

This rule is derived for: IL, ST, LD and FBD languages.

Default level = FATAL

Accept filtering by user’s group in case of variables

Any IN parameter of a UDFB or sub-program must be read in its implementation.

Default level = FATAL

Accept filtering by user’s group in case of variables

Any OUT parameter of a UDFB or sub-program must be written in its implementation. It can be read, but only if it was written before.

Default level = FATAL

Accept filtering by user’s group in case of variables

Any INOUT parameter of a UDFB or sub-program must be read and written in its implementation.

Default level = ERROR

Does not accept filtering by user’s group

This applies to jump and return instructions in LD, FBD and IL, plus RETURN, EXIT and GOTO statements in ST.

Default level = FATAL

Does not accept filtering by user’s group

Text associated to graphic items in LD and FBD programs should not be complex expressions. For instance, associating "IntVar > iMax" to a LD contact is not accepted.

Default level = WARNING

Does not accept filtering by user’s group

Default level = WARNING

Does not accept filtering by user’s group

This applies to both "IF" and "CASE" statements in ST language.

Default level = ERROR

Does not accept filtering by user’s group

Any declared UDFB or sub-program must be used at least once in the project. Conditional compiling is forbidden.

Default level = FATAL

Does not accept filtering by user’s group

The option "Forbid equality tests between reals" must be checked in the "Compiler" section of the "Project Settings" box.

Default level = INFO

Does not accept filtering by user’s group

Maximum value configurable

This applies to nesting of any IF, WHILE, REPEAT, FOR, CASE structure in ST language.

Default level = ERROR

Does not accept filtering by user’s group

The instructions "WAIT", "WAIT_TIME" and "DO_WAIT" should not be used in ST.

Default level = ERROR

Does not accept filtering by user’s group

The instructions "WHILE", "REPEAT" and "FOR" should not be used in ST.

Default level = ERROR

Does not accept filtering by user’s group

This refers to an option in the "Project Settings" box. In the "Advanced" category, the "Deny unwired inputs in FBD" should be checked.

Default level = WARNING

Does not accept filtering by user’s group

Maximum value configurable

This applies to the entire POU contents, including comments and empty lines.

Default level = WARNING

Does not accept filtering by user’s group

Maximum value configurable

Default level = WARNING

Does not accept filtering by user’s group

Maximum value configurable

Any function, operator or function block inserted in the diagram is counted.

Default level = WARNING

Does not accept filtering by user’s group

Maximum value configurable

Default level = WARNING

Does not accept filtering by user’s group

The IEC standard considers that a SFC step without any condition is considered as always TRUE. In order to comply to this Code Checker rule, you should explicitly enter "TRUE" in the condition of such a transition.

Default level = ERROR

Accept filtering by user’s group in case of variables

Unused variables should not remain in the project.

Default level = WARNING

Accept filtering by user’s group in case of variables

Default level = ERROR

Accept filtering by user’s group in case of variables

This also applies to global variables read or written among several POUs, according to their execution order. This rule is not applied to variables declared as "Read only".

Default level = FATAL

Accept filtering by user’s group in case of variables

This regards calling of the same declared instance of the same function block.
You should check the project settings option: "Check multiple calls to FB instances"

Default level = ERROR

Accept filtering by user’s group in case of variables

It is allowed that the global variable is read in other POUs.

Default level = FATAL

Accept filtering by user’s group in case of variables

This applies to both local variables used within one POU and global variables used in several POUs of the project.

Default level = WARNING

Accept filtering by user’s group in case of variables

Default level = WARNING

Does not accept filtering by user’s group

The use of parallel branches (AND divergences) in SFC programs is not allowed.

Default level = FATAL

Does not accept filtering by user’s group

In the "Project Settings" box, the compiling option "Check safety of SFC charts" must be enabled.

Default level = INFO

Accept filtering by user’s group in case of variables

This rule does not apply to: channels of an input board (%), arrays, structures, instances of function block, input or output parameters of UDFBs and sub-programs.

Default level = FATAL

Does not accept filtering by user’s group

This rule refers to compiling options set from the "Project Settings" box. The code should not be compiled in DEBUG mode. The "Variable Locking" feature should not be enabled. Online Change should not be enabled.

Default level = FATAL

Does not accept filtering by user’s group

This rule refers to compiling options set from the "Project Settings" box. The compiling option "Check array indexes at Runtime Service" should be checked.

Default level = FATAL

Does not accept filtering by user’s group

This rule refers to compiling options set from the "Project Settings" box. In the settings of the "Enable Dynamic memory allocation" or the "Runtime Service" memory should not be configured to use Operating System dynamic memory.

Created with the Personal Edition of HelpNDoc: Full-featured multi-format Help generator