Allgemeines
Themenpunkte:
Allgemeine Namensvorgaben
- Namen sind aussagekräftig, um den Zweck des Objekts leicht verstehen zu können.
- Vermeiden Sie mehrfaches Nutzen gleicher Namen. Sehen Sie dazu auch den Themenpunkt Kein mehrfaches Nutzen gleicher Namen im Abschnitt Programmierung.
- Besteht ein Bezeichner aus mehreren Wörtern, wird der erste Buchstabe eines jeden Wortes großgeschrieben (CamelCase). In der Regel werden keine Trennzeichen, wie z. B. '_', zwischen den Wörtern verwendet. Sollte in Ausnahmefällen eine gute Lesbarkeit mittels CamelCase nicht erreicht werden können, wird die Verwendung des Unterstrich-Zeichens als Trennzeichen empfohlen. Weitere Ausnahmen für die Verwendung des Unterstrich-Zeichens bei Objektnamen finden Sie unter dem Themenpunkt Gültige Zeichen beachten.
- Bezeichner haben ein konsistentes Präfix, sodass der Objekttyp leicht zu erkennen ist. Wird für einen Bezeichner ein Präfix vorgeschrieben, beachten Sie die entsprechende Groß- bzw. Kleinschreibung. Sehen Sie dazu auch: Bezeichner
- Bezeichner beginnen immer mit einem Buchstaben.
- Abkürzungen werden ebenfalls in CamelCase geschrieben. (Ausnahmen sind eigenständige Begriffe wie ID, CRLF, PC, PLC, …. Diese können in UpperCase geschrieben werden.)
Negative Beispiele:
tADSTimeout : TIME;
eCMDType : E_CommandType;Positive Beispiele:
nAddr : UDINT;
nMsgCtrlMask : DWORD;
cMaxCharacters : UDINT;
tAdsTimeout : TIME;
eCmdType : E_CommandType;
stRemotePCInfo : ST_RemotePCInfo;Übliche Abkürzungen
Folgende übliche Abkürzungen können verwendet werden. Es darf für den entsprechenden Begriff keine andere Abkürzung gewählt werden.
Ebenso finden sich in der Liste Begriffe, welche nicht abgekürzt werden sollen. Verzichten Sie allgemein auf Abkürzungen, welche den Begriff um weniger als 3 Buchstaben kürzen würden, weil dies die Lesbarkeit nicht verbessert. (Ausnahmen sind die Abkürzungen Cnt und Idx.)
Abkürzung | Begriff |
|---|---|
Abs | Absolute |
Ack | Acknowledge |
Act | Actual / Active (Current) |
Addr | Address |
/ | Alarm |
Auto | Automatic |
Avg | Average |
Bwd | Backward |
/ | Buffer |
Calc | Calculation / Calculate |
Char | Character |
Cmd | Command |
Com | Communication |
Config | Configuration |
Cnt | Count (Number of) |
Dst | Destination |
Diag | Diagnostic(s) |
Diff | Difference |
Dim | Dimension |
/ | Error |
/ | Execute |
Fwd | Forward |
Hdl | Handle |
ID | Identifier |
Idx | Index |
In | Input |
Info | Information |
Init | Initialization / Initialize |
Itf | Interface |
Len | Length |
Lib | Library |
Max | Maximum |
Mem | Memory |
Min | Minimum |
Msg | Message |
Obj | Object |
Op | Operation |
Out | Output |
Ptr | Pointer |
Pos | Position |
Prev | Previous |
Rcv | Receive / Received |
Ref | Reference |
Src | Source |
Srv | Server |
Sync | Synchonize / Synchronization |
Temp | Temperature |
Tmp | Temporary |
/ | Timeout |
Velo | Velocity |
Visu | Visualization |
/ | Warning |