Skip to main content

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 *) *)

在联机模式下，注释作为变量信息显示在变量声明的注释列中，当鼠标指针放在变量上方时，也会显示在工具提示中。以下逻辑和优先级排序适用

  1. 当评论以开头时 /// 在变量之前，显示此注释。

  2. 当评论以开头时 // 或者在里面 (**) 在同一行变量声明之后，显示此注释

  3. 当评论以开头时 // 或者在里面 (**) 在同一行中的变量声明之前，显示此注释

如果评论由于长度而无法在联机模式下完整显示，那么 _cds_icon_comment_more_lines.png 符号显示在此注释字段中。然后将光标置于该符号上方时，完整的注释将显示在工具提示中

例 79. 工具提示和 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


注意：不同的注释类型可用于控制哪些注释应显示在库的文档中，以及哪些注释仅供库开发人员使用。

本节内容如下: