Skip to main content

Comentarios ST

Comentario

Descripción

Ejemplo

Linea sola

Hay dos formas de marcar:

  • Comienza con // y termina al final de la línea

  • Comienza con /// y termina al final de la línea

En CODESYS, estos comentarios se manejan de la misma manera.

Sin embargo, si la documentación de la biblioteca se crea utilizando la colección de secuencias de comandos LibDoc, se aplica lo siguiente:

  • Cuando la propiedad LibDocContent = DocsOnly se ingresa en la información del proyecto, solo los comentarios marcados con /// se procesan en la documentación de la biblioteca. Vea el ejemplo de esto debajo de la tabla.

  • Cuándo LibDocContent = CommentsAndDocs (configuración predeterminada), todos los comentarios se procesan en la documentación de la biblioteca.

/// This is a comment

/// This is a comment

multilínea

Comienza con (* y termina con *).

(* This is a multiline comment *)

Anidado

Empieza con (* y termina con *). Comentarios adicionales (*....*) puede estar contenido en este comentario.

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

Los comentarios se muestran como información sobre una variable en la columna de comentarios de la declaración de variables en el modo en línea, así como en la información sobre herramientas cuando el puntero del ratón se coloca sobre una variable. Se aplican la siguiente lógica y priorización

  1. Cuando un comentario empieza por /// está antes de la variable, se muestra este comentario.

  2. Cuando un comentario empieza por // o dentro (**) está después de la declaración de la variable en la misma línea, se muestra este comentario

  3. Cuando un comentario empieza por // o dentro (**) está antes de la declaración de la variable en la misma línea, se muestra este comentario

Si un comentario no se puede mostrar completo en el modo en línea debido a su longitud, entonces el _cds_icon_comment_more_lines.png el símbolo se muestra en este campo de comentarios. Cuando el cursor se coloca sobre este símbolo, el comentario completo se muestra en la descripción emergente

ejemplo 79. Comentarios para información sobre herramientas y documentación de 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


Nota: Los diferentes tipos de comentarios se pueden usar para controlar qué comentarios deben mostrarse en la documentación de una biblioteca y qué comentarios están destinados solo a los desarrolladores de bibliotecas.

En esta sección: