ST - 评论

评论	说明	示例
单线	标记有两种方法：以`‎//‎` 开头，以行尾结束以`‎///‎` 开头，以行尾结束在CODESYS 中，处理这些评论的方式相同。但是，如果库文档是使用 LibDoc 脚本集创建的，则以下情况适用：在项目信息中输入属性`‎LibDocContent = DocsOnly‎` 时，只有标有`‎///‎` 的注释才会被处理成库文件。请参见表格下方的示例。当`‎LibDocContent = CommentsAndDocs‎` （默认设置）被定义时，所有注释都会被处理成库文档。	`‎/// This is a comment.‎` `‎/// This is a comment.‎`
多线	以`‎(‎` 开头，以`‎)‎` 结尾。	`‎(* This is a multiline comment *)‎`
嵌套	以`‎(‎` 开头，以`‎)‎` 结尾。其他评论`‎(....)‎` 可包含在本评论中。	`‎( * a:=inst.out; (* comment 1 ) b:=b+1; ( comment 2 ) )‎`

说明

示例

单线

标记有两种方法：

以‎//‎ 开头，以行尾结束
以‎///‎ 开头，以行尾结束

在CODESYS 中，处理这些评论的方式相同。

但是，如果库文档是使用 LibDoc 脚本集创建的，则以下情况适用：

在项目信息中输入属性‎LibDocContent = DocsOnly‎ 时，只有标有‎///‎ 的注释才会被处理成库文件。请参见表格下方的示例。
当‎LibDocContent = CommentsAndDocs‎ （默认设置）被定义时，所有注释都会被处理成库文档。

‎/// This is a comment.‎

多线

以‎(*‎ 开头，以‎*)‎ 结尾。

‎(* This is a multiline comment *)‎

嵌套

以‎(*‎ 开头，以‎*)‎ 结尾。其他评论‎(*....*)‎ 可包含在本评论中。

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

对工具提示和 POU 文档的评论

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

请注意：不建议混合使用不同的注释类型，因为这会在生成文档时产生不必要的副作用。