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

Beispiel 70. 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: Eine Mischung der verschiedenen Kommentartypen ist nicht zu empfehlen, weil dies zu unerwünschten Effekten im Fall der Dokumentationserzeugung führen kann.