Blog

CODESYS: Funktionsbausteine dokumentieren

Funktionsbausteine in CODESYS mit strukturierten Kommentaren dokumentieren: Listen, Tabellen, Rückgabewerte und Bilder.

  • CODESYS
  • SPS
  • Programmierung
Inhalt
  1. Listen und Tabellen
  2. Rückgabewert
  3. Bilder einbinden

CODESYS unterstützt strukturierte Bausteinkommentare mit reStructuredText (reST). Damit lassen sich Listen, Tabellen, Rückgabewerte und Bilder dokumentieren.

Listen und Tabellen

Der Kommentar steht direkt vor der Bausteindeklaration:

// Kurze Beschreibung des Bausteins.
//
// Aufzählung:
//
// * Punkt 1
// * Punkt 2
//
// Tabelle:
//
// +----------+----------+
// | Spalte 1 | Spalte 2 |
// +==========+==========+
// | Wert A   | Wert B   |
// +----------+----------+
FUNCTION_BLOCK Beispiel
VAR_INPUT
    myVar : INT; // Beschreibung des Eingangs
END_VAR

Rückgabewert

Bei Funktionen kann der Rückgabewert beschrieben werden:

// :return: Beschreibung des Rückgabewerts
FUNCTION BeispielFunktion : INT

Bilder einbinden

Grafik zunächst im Projekt oder in der Bibliothek über Objekt hinzufügen → Externe Datei hinzufügen. Anschließend im Kommentar referenzieren:

// .. image:: ../Image/Bildname.png
//    :width: 50%

Hinweis: Der Bildpfad muss zur Projektstruktur passen. Die Darstellung kann je nach CODESYS-Version abweichen.

Weitere Artikel