Bezeichner

Regeln für die Bezeichnervergabe

Regeln für den Bezeichner einer Variablen

Ein Bezeichner darf keine Leerzeichen oder Sonderzeichen enthalten.
Groß-/Kleinschreibung wird nicht beachtet. Beispielsweise bezeichnen ‎VAR1‎ und ‎var1‎ dieselbe Variable.
Der Unterstrich wird erkannt. Beispielsweise werden ‎A_BCD‎ und ‎AB_CD‎ als zwei verschiedene Bezeichner behandelt. Mehrfach aufeinander folgende Unterstriche sind nicht erlaubt.
Die Länge eines Bezeichners ist unbegrenzt.

Regeln für die Mehrfachverwendung von Bezeichnern (Namensräume)

Ein Bezeichner darf lokal nicht doppelt deklariert werden.
Ein Bezeichner kann global mehrfach verwendet werden. Wenn eine lokale Variable denselben Namen hat wie eine globale Variable, hat die lokale Variable innerhalb einer POU den Vorrang.
Ein Bezeichner darf nicht identisch mit einem Schlüsselwort sein, wie beispielsweise dem Gültigkeitsbereich ‎VAR_Global‎.
Eine Variable, die in einer globalen Variablenliste deklariert ist, kann denselben Namen haben wie eine Variable, die in einer anderen GVL definiert ist. CODESYS bietet folgende norm-erweiternden Funktionalitäten bezüglich des Namensraums oder Gültigkeitsbereichs von Variablen an:
- Globaler Namensraum-Operator:
  
  Ein Instanzpfad, der mit einem Punkt beginnt, öffnet immer einen globalen Namensraum. Wenn es eine lokale Variable, zum Beispiel ‎ivar‎, gibt, die denselben Namen hat wie eine globale Variable, sprechen Sie mit ‎.ivar‎ die globale Variable an.
- Der Name einer globalen Variablenliste kann den Namensraum für die enthaltenen Variablen eindeutig definieren. Somit können Sie Variablen mit demselben Namen in verschiedenen globalen Variablenlisten deklarieren und dennoch durch das Voranstellen des Listennamens eindeutig ansprechen.
  
  Beispiel: ‎globlist1.ivar := globlist2.ivar; (* ivar aus GVL globlist2 wird auf ivar in GVL globlist1 kopiert *)‎
- Variablen, die in der globalen Variablenliste einer ins Projekt eingebundenen Bibliothek definiert sind, können Sie gemäß der folgenden Syntax eindeutig ansprechen:
  
  ‎<name scope library>.< GVL name>.<variable name>‎
  
  Beispiel: ‎globlist1.ivar := lib1.globlist1.ivar (* ivar aus GVL globlist1 in Bibliothek lib1 wird auf ivar in GVL globlist1 kopiert *)‎
Für eine Bibliothek wird beim Einfügen via Bibliotheksverwalter auch ein Namensraum definiert. Somit können Sie einen Bibliotheksbaustein oder eine Bibliotheksvariable über ‎<Namensraum Bibliothek>.<Bausteinname|Variablenname>‎ eindeutig ansprechen. Beachten Sie im Fall von verschachtelten Bibliotheken, dass die Namensräume aller beteiligten Bibliotheken in Folge anzugeben sind.

Beispiel: Wenn ‎Lib1‎ durch ‎Lib0‎ referenziert wird, so wird der in ‎Lib1‎ enthaltene Baustein ‎func‎ über ‎Lib0.Lib1.fun‎ angesprochen: ‎ivar := Lib0.Lib1.fun(4, 5); (* Rückgabewert von func wird auf Variable ivar im Projekt kopiert *)‎

Zusätzlich zu den Punkten, die Sie speziell bei der Variablendeklaration beachten müssen, wird empfohlen die folgenden Regeln anzuwenden. Damit erreichen Sie eine möglichst weitgehende Vereinheitlichung bei der Namensvergabe.

Empfehlungen für Variablennamen

Bezeichnen Sie Variablen in Applikationen und Bibliotheken möglichst angelehnt an die ungarische Notation. Finden Sie für jede Variable als Basisnamen eine sinnvolle, möglichst kurze, englische Bezeichnung, die aus mehreren Worten bestehen kann. Schreiben Sie den jeweils ersten Buchstaben eines Worts groß, die übrigen Buchstaben klein. Hängen Sie vor den Basisnamen Präfix(e) in Kleinbuchstaben entsprechend dem Datentyp der Variablen.

Beispiel: ‎iFileSize : INT;‎

Datentyp	Präfix	Beschreibung
`‎BOOL‎`	`‎x‎`	Bewusst wird als Präfix für boolesche Variablen `‎x‎` empfohlen, um sich von Bezeichnern des Datentyps `‎BYTE‎` abzugrenzen. Das Präfix verdeutlicht die Sicht eines IEC-Programmierers.
	`‎b‎`	Reserviert
`‎BYTE‎`	`‎by‎`	Bitfolge, nicht für arithmetische Operationen
`‎WORD‎`	`‎w‎`	Bitfolge, nicht für arithmetische Operationen
`‎DWORD‎`	`‎dw‎`	Bitfolge, nicht für arithmetische Operationen
`‎LWORD‎`	`‎lw‎`	Bitfolge, nicht für arithmetische Operationen

`‎SINT‎`	`‎si‎`	Arithmetischer ganzzahliger Datentyp, 8 Bit
`‎USINT‎`	`‎usi‎`	Arithmetischer ganzzahliger Datentyp, 8 Bit
`‎INT‎`	`‎i‎`	Arithmetischer ganzzahliger Datentyp, 16 Bit
`‎UINT‎`	`‎ui‎`	Arithmetischer ganzzahliger Datentyp, 16 Bit
`‎DINT‎`	`‎di‎`	Arithmetischer ganzzahliger Datentyp, 32 Bit
`‎UDINT‎`	`‎udi‎`	Arithmetischer ganzzahliger Datentyp, 32 Bit
`‎LINT‎`	`‎li‎`	Arithmetischer ganzzahliger Datentyp, 64 Bit
`‎ULINT‎`	`‎uli‎`	Arithmetischer ganzzahliger Datentyp, 64 Bit

`‎REAL‎`	`‎r‎`	Arithmetischer Gleitpunktdatentyp, 32 Bit
`‎LREAL‎`	`‎lr‎`	Arithmetischer Gleitpunktdatentyp, 64 Bit

`‎STRING‎`	`‎s‎`	Einzelbyte-Zeichenfolge variabler Länge (Standardeinstellung 80 Zeichen)
`‎WSTRING‎`	`‎ws‎`	Doppelbyte-Zeichenfolge variabler Länge (Standardeinstellung 80 Zeichen)

`‎TIME‎`	`‎tim‎`	Zeitdauer, 32 Bit
`‎LTIME‎`	`‎ltim‎`	Zeitdauer, 64 Bit

`‎TIME_OF_DAY‎` `‎TOD‎`	`‎tod‎`	Uhrzeit (Tageszeit), 32 Bit
`‎LTIME_OF_DAY‎` `‎LTOD‎`	`‎ltod‎`	Uhrzeit (Tageszeit), 64 Bit
`‎DATE_AND_TIME‎` `‎DT‎`	`‎dt‎`	Datum und Uhrzeit
`‎LDATE_AND_TIME‎` `‎LDT‎`	`‎ldt‎`
`‎DATE‎`	`‎dat‎` `‎d‎`	Kalenderdatum
`‎LDATE‎`	`‎ldat‎` `‎ld‎`	Kalenderdatum

`‎POINTER‎`	`‎p‎`
`‎ARRAY‎`	`‎a‎`
Enumeration	`‎e‎`

Beispiel

VAR
	bySubIndix: BYTE;
	xFlag: BOOL;
	udiCounter: UDINT;
END_VAR

Bezeichner	Beschreibung	Beispiel
Verschachtelte Deklaration	Präfixe werden in der Reihenfolge der Deklaration aneinander gehängt	`‎pabyTelegramData: POINTER TO ARRAY [0..7] OF BYTE;‎`
Funktionsbaustein-Instanz Variable vom benutzerdefinierten Datentyp	Präfix: Kürzel für den Funktionsbaustein- oder Datentypnamen	`‎cansdoReceivedTelegram: CAN_SDOTelegram;‎` `‎TYPE CAN_SDOTelegram : (* prefix: sdo *)‎` `‎STRUCT‎` `‎ﾠwIndex: WORD;‎` `‎ﾠbySubIndex:BYTE;‎` `‎ﾠbyLen:BYTE;‎` `‎ﾠaby: ARRAY [0..3] OF BYTE;‎` `‎END_STRUCT‎` `‎END_TYPE‎`
Lokale Konstante Lokale konstante Variable	Präfix: `‎c_‎`, gefolgt vom Typpräfix und dem Variablennamen	`‎VAR CONSTANT‎` `‎ﾠc_uiSyncID: UINT := 16#80;‎` `‎END_VAR‎`
Globale Variable	An das Bibliothekspräfix wird ein zusätzliches Präfix angehängt `‎g_‎`	`‎VAR_GLOBAL‎` `‎ﾠCAN_g_iTest: INT;‎` `‎END_VAR‎`
Globale Konstante Globale konstante Variable	An das Bibliothekspräfix wird ein zusätzliches Präfix angehängt `‎gc_‎`	`‎VAR_GLOBAL CONSTANT‎` `‎ﾠCAN_gc_dwExample: DWORD;‎` `‎END_VAR‎`

Empfehlungen für Variablennamen in CODESYS V3.x Bibliotheken

Bezeichner	Beschreibung	Beispiel
Variable	Entspricht der obigen Beschreibung für Variablennamen mit der Ausnahme, dass globale Variablen und Konstanten kein Bibliothekspräfix benötigen, da der Namensraum die Funktion ersetzt.	`‎g_iTest: INT; // Declaration‎` `‎CAN.g_iTest; // Implementation; call in the program‎`

Bezeichner

Beschreibung

Beispiel

Variable

Entspricht der obigen Beschreibung für Variablennamen mit der Ausnahme, dass globale Variablen und Konstanten kein Bibliothekspräfix benötigen, da der Namensraum die Funktion ersetzt.

‎g_iTest: INT; // Declaration‎

‎CAN.g_iTest; // Implementation; call in the program‎

Empfehlungen für Bezeichner für benutzerdefinierte Datentypen (DUT)

Bezeichner für	Beschreibung	Beispiel
Strukturen	Bibliothekspräfix, gefolgt von einem Unterstrich und einer kurzen, aussagekräftigen Beschreibung der Struktur. Das zugehörige Präfix für angelegte Variablen dieser Struktur soll als Kommentar direkt nach dem Doppelpunkt folgen.	`‎TYPE CAN_SDOTelegram : (* prefix: sdo *) ‎` `‎STRUCT‎` `‎ﾠwIndex : WORD;‎` `‎ﾠbySubIndex : BYTE;‎` `‎ﾠbyLen : BYTE;‎` `‎ﾠabyData: ARRAY [0..3] OF BYTE;‎` `‎ END_STRUCT‎` `‎END_TYPE‎`
Enumerationen	Bibiliothekspräfix, gefolgt von einem Unterstrich und dem Bezeichner in Großbuchstaben. Zu beachten: In vergangenen CODESYS-Versionen haben Enumerationswerte > 16#7FFF zu Fehlern geführt, da sie nicht automatisch in `‎INT‎` konvertiert wurden. Aus diesem Grund sollen Enumerationen stets mit korrekten `‎INT‎`-Werten deklariert werden.	`‎TYPE CAL_Day :‎` `‎(‎` `‎ﾠCAL_MONDAY,‎` `‎ﾠCAL_TUESDAY,‎` `‎ﾠCAL_WEDNESDAY,‎` `‎ﾠCAL_THURSDAY,‎` `‎ﾠCAL_FRIDAY,‎` `‎ﾠCAL_SATURDAY,‎` `‎ﾠCAL_SUNDAY‎` `‎);‎` Deklaration: `‎eToday: CAL_Day;‎`

Bezeichner für

Beschreibung

Beispiel

Strukturen

Bibliothekspräfix, gefolgt von einem Unterstrich und einer kurzen, aussagekräftigen Beschreibung der Struktur. Das zugehörige Präfix für angelegte Variablen dieser Struktur soll als Kommentar direkt nach dem Doppelpunkt folgen.

‎TYPE CAN_SDOTelegram : (* prefix: sdo *) ‎

‎STRUCT‎

‎ﾠwIndex : WORD;‎

‎ﾠbySubIndex : BYTE;‎

‎ﾠbyLen : BYTE;‎

‎ﾠabyData: ARRAY [0..3] OF BYTE;‎

‎ END_STRUCT‎

‎END_TYPE‎

Enumerationen

Bibiliothekspräfix, gefolgt von einem Unterstrich und dem Bezeichner in Großbuchstaben.

Zu beachten: In vergangenen CODESYS-Versionen haben Enumerationswerte > 16#7FFF zu Fehlern geführt, da sie nicht automatisch in ‎INT‎ konvertiert wurden. Aus diesem Grund sollen Enumerationen stets mit korrekten ‎INT‎-Werten deklariert werden.

‎TYPE CAL_Day :‎

‎(‎

‎ﾠCAL_MONDAY,‎

‎ﾠCAL_TUESDAY,‎

‎ﾠCAL_WEDNESDAY,‎

‎ﾠCAL_THURSDAY,‎

‎ﾠCAL_FRIDAY,‎

‎ﾠCAL_SATURDAY,‎

‎ﾠCAL_SUNDAY‎

‎);‎

Deklaration:

‎eToday: CAL_Day;‎

Empfehlungen für Bezeichner für benutzerdefinierte Datentypen (DUT) in CODESYS V3-Bibliotheken

Bezeichner für	Beschreibung	Beispiel
DUT-Namen in CODESYS V3-Bibliotheken	Es wird auf das Bibliothekspräfix verzichtet, da die Funktion des Bibliothekspräfixes durch den Namensraum ersetzt wird. Auch die Enumerationswerte werden ohne Bibliothekspräfix definiert.	Bibliothek mit Namensraum `‎CAL‎` `‎TYPE DAY :‎` `‎(‎` ﾠ`‎MONDAY‎` ﾠ`‎TUESDAY,‎` ﾠ`‎WEDNESDAY,‎` ﾠ`‎THURSDAY,‎` ﾠ`‎FRIDAY,‎` ﾠ`‎SATURDAY,‎` ﾠ`‎SUNDAY‎` `‎);‎` Deklaration: `‎eToday: CAL.Day;‎` Verwendung in der Applikation `‎IF eToday = CAL.Day.MONDAY THEN‎`

Bezeichner für

Beschreibung

Beispiel

DUT-Namen in CODESYS V3-Bibliotheken

Es wird auf das Bibliothekspräfix verzichtet, da die Funktion des Bibliothekspräfixes durch den Namensraum ersetzt wird. Auch die Enumerationswerte werden ohne Bibliothekspräfix definiert.

Bibliothek mit Namensraum ‎CAL‎

‎TYPE DAY :‎

‎(‎

ﾠ‎MONDAY‎

ﾠ‎TUESDAY,‎

ﾠ‎WEDNESDAY,‎

ﾠ‎THURSDAY,‎

ﾠ‎FRIDAY,‎

ﾠ‎SATURDAY,‎

ﾠ‎SUNDAY‎

‎);‎

Deklaration:

‎eToday: CAL.Day;‎

Verwendung in der Applikation

‎IF eToday = CAL.Day.MONDAY THEN‎

Empfehlungen für Bezeichner für POUs: Funktionen, Funktionsbausteine, Programme

Bezeichner für	Beschreibung	Beispiel
POUs: Funktionen, Funktionsbausteine, Programme	Bibliothekspräfix gefolgt von einem Unterstrich und einem aussagekräftigen, möglichst kurzen Namen der POU. Wie bei den Variablen soll der jeweils erste Buchstabe eines Worts des Basisnamens groß, die übrigen klein geschrieben werden. Es wird empfohlen, den Namen der POU aus einem Verb und einem Substantiv zusammenzusetzen. Bei Funktionsbausteinen soll das zugehörige Präfix für angelegte Instanzen als Kommentar direkt nach dem Namen folgen.	`‎FUNCTION_BLOCK CAN_SendTelegram (* prefix: canst *)‎`
Aktionen	Nur Aktionen, die der Baustein selbst aufruft, beginnen mit `‎prv_‎`. Ansonsten erhalten Aktionen kein Präfix

Bezeichner für

Beschreibung

Beispiel

POUs: Funktionen, Funktionsbausteine, Programme

Bibliothekspräfix gefolgt von einem Unterstrich und einem aussagekräftigen, möglichst kurzen Namen der POU. Wie bei den Variablen soll der jeweils erste Buchstabe eines Worts des Basisnamens groß, die übrigen klein geschrieben werden. Es wird empfohlen, den Namen der POU aus einem Verb und einem Substantiv zusammenzusetzen.

Bei Funktionsbausteinen soll das zugehörige Präfix für angelegte Instanzen als Kommentar direkt nach dem Namen folgen.

‎FUNCTION_BLOCK CAN_SendTelegram (* prefix: canst *)‎

Aktionen

Nur Aktionen, die der Baustein selbst aufruft, beginnen mit ‎prv_‎. Ansonsten erhalten Aktionen kein Präfix

Empfehlungen für Bezeichner für POUs in CODESYS V3 Bibliotheken

Bezeichner für	Beschreibung	Beispiel
POU	Es wird auf das Bibliothekspräfix verzichtet, da der Namensraum die Funktion des Bibliothekspräfix ersetzt	`‎FUNCTION_BLOCK SendTelegram (* prefix: canst *)‎`
Methode	Nur Methoden, die der Baustein selbst aufruft, beginnen mit `‎prv_‎` Ansonsten erhalten Methoden kein Präfix
Interface Schnittstelle	`‎I‎`	`‎ICANDevice‎`

Bezeichner für

Beschreibung

Beispiel

POU

Es wird auf das Bibliothekspräfix verzichtet, da der Namensraum die Funktion des Bibliothekspräfix ersetzt

‎FUNCTION_BLOCK SendTelegram (* prefix: canst *)‎

Methode

Nur Methoden, die der Baustein selbst aufruft, beginnen mit ‎prv_‎

Ansonsten erhalten Methoden kein Präfix

Interface

Schnittstelle

‎I‎

‎ICANDevice‎

Empfehlungen für Bezeichner für Visualisierungen

HINWEIS

Achten Sie darauf, dass eine Visualisierung nicht denselben Namen erhält wie ein anderer Baustein im Projekt, da dies bei Visualisierungswechseln zu Problemen führen würde.

Siehe auch