Skip to main content

ST-Kommentare

Kommentar

Beschreibung

Beispiel

Einzeilig

Es gibt zwei Möglichkeiten der Kennzeichnung:

  • Beginnt mit // und endet am Ende der Zeile

  • Beginnt mit /// und endet am Ende der Zeile

In CODESYS werden diese Kommentare gleich behandelt.

Wenn allerdings mit Hilfe der LibDoc Scripting Collection Bibliotheksdokumentation erzeugt wird, gilt Folgendes:

  • Wenn in den Projektinformationen das Property LibDocContent = DocsOnly eingetragen ist, werden nur mit /// gekennzeichnete Kommentare zu Bibliotheksdokumentation verarbeitet. Siehe dazu das Beispiel unterhalb der Tabelle.

  • Wenn LibDocContent = CommentsAndDocs (Standardeinstellung) definiert ist, werden alle Kommentare zu Bibliotheksdokumentation verarbeitet.

/// This is a comment

/// This is a comment

Mehrzeilig

Beginnt mit (* und endet mit *).

(* This is a multiline comment *)

Verschachtelt

Beginnt mit (* und endet mit *). Innerhalb dieses Kommentars können weitere (*....*) Kommentare enthalten sein.

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

Die Kommentare werden als Information zu einer Variablen in der Kommentarspalte der Variablendeklaration im Onlinebetrieb und im Tooltip angezeigt, wenn der Mauszeiger über einer Variablen steht. Dabei gelten folgende Logik und Priorisierung:

  1. Wenn ein Kommentar, der mit /// beginnt, vor der Variablen steht, dann wird dieser Kommentar angezeigt

  2. Wenn ein Kommentar, der mit // beginnt oder innerhalb von (**) steht, nach der Variablendeklaration in der gleichen Zeile steht, dann wird dieser Kommentar angezeigt

  3. Wenn ein Kommentar, der mit // beginnt oder innerhalb von (**) steht, vor der Variablendeklaration in der gleichen Zeile steht, dann wird dieser Kommentar angezeigt

Wenn im Onlinebetrieb ein Kommentar aufgrund seiner Länge nicht vollständig angezeigt werden kann, wird in diesem Kommentarfeld das Symbol _cds_icon_comment_more_lines.png angezeigt. Wenn dann der Cursor auf diesem Symbol positioniert wird, wird im Tooltip der vollständige Kommentar angezeigt.

Beispiel 79. Kommentare für Tooltip und Bausteindokumentation
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


Hinweis: Durch die verschiedenen Kommentartypen kann gesteuert werden, welche Kommentare in der Dokumentation einer Bibliothek angezeigt werden sollen, und welche Kommentare nur für Bibliotheksentwickler gedacht sind.

In diesem Abschnitt: