ST – Comments

Comment	Description	Example
Single-line	There are two ways of marking: Starts with `‎//‎` and ends at the end of the line Starts with `‎///‎` and ends at the end of the line In CODESYS, these comments are handled the same way. However, if library documentation is created using the LibDoc Scripting Collection, the following applies: When the property `‎LibDocContent = DocsOnly‎` is entered in the project information, only comments marked with `‎///‎` are processed into library documentation. See the example for this below the table. When `‎LibDocContent = CommentsAndDocs‎` (default setting) is defined, all comments are processed into library documentation.	`‎/// This is a comment.‎` `‎/// This is a comment.‎`
Multiline	Starts with `‎(‎` and ends with `‎)‎`.	`‎(* This is a multiline comment *)‎`
Nested	Starts with `‎(‎` and ends with `‎)‎`. Additional comments `‎(....)‎` can be contained within this comment.	`‎( * a:=inst.out; (* comment 1 ) b:=b+1; ( comment 2 ) )‎`

Comment

Description

Example

Single-line

There are two ways of marking:

Starts with ‎//‎ and ends at the end of the line
Starts with ‎///‎ and ends at the end of the line

In CODESYS, these comments are handled the same way.

However, if library documentation is created using the LibDoc Scripting Collection, the following applies:

When the property ‎LibDocContent = DocsOnly‎ is entered in the project information, only comments marked with ‎///‎ are processed into library documentation. See the example for this below the table.
When ‎LibDocContent = CommentsAndDocs‎ (default setting) is defined, all comments are processed into library documentation.

‎/// This is a comment.‎

Multiline

Starts with ‎(*‎ and ends with ‎*)‎.

‎(* This is a multiline comment *)‎

Nested

Starts with ‎(*‎ and ends with ‎*)‎. Additional comments ‎(*....*)‎ can be contained within this comment.

‎( * a:=inst.out; (* comment 1 *) b:=b+1; (* comment 2 *) *)‎

Comments for tooltips and POU documentation

A tooltip in the header of a POU is defined by the following comment:
    // tooltip text – line 1
    // tooltip text – line 2
    // tooltip text – line 3

    Afterwards the documentation is defined as follows:
    /// reStructuredText

Note: It is not recommended to mix the different comment types because this can cause unwanted side-effects when the documentation is generated.