Regeln für die Benennung von Objekttypkomponenten (BOR)
Für jede Objekttypkomponente existiert eine Kennung , eine Bezeichnung und eine Kurzbeschreibung , für deren Benennung folgende Regeln gelten:
Kennung
-
Die Kennungen aller Objekttypkomponenten eines Objekttyp müssen eindeutig sein. Eine Kennung, die z.B. bereits für ein Schlüsselfeld vergeben worden ist, kann nicht mehr als Kennung für ein Attribut, eine Methode oder ein Ereignis verwendet werden.
-
Die Kennung einer Objekttypkomponente hat identifizierenden Charakter. Sie ist maximal 20 Zeichen lang und soll englischsprachig und semantisch verständlich sein. Die Kennung beginnt mit einem Buchstaben, gefolgt von Buchstaben, Ziffern und Unterstrichen.
-
Die Groß- und Kleinschreibung hat für die Identifizierung keine Bedeutung, da hierfür nur die Großschreibung verwendet wird. Aus diesem Grunde kann eine Nur-Großschreibung ohne Probleme in eine Groß-Kleinschreibung umbenannt werden. Eine Groß-Kleinschreibung auch innerhalb eines Wortes dient immer der besseren Lesbarkeit.
-
Die Kennung einer Objekttypkomponente darf nicht die Kennung des Objekttyps bzw. den Objektnamen wiederholen . In der Auflistung wird die Objekttypkennung der Kennung vorangestellt. Die Kennungen von Objekttyp und Objekttypkomponente sind durch einen Punkt getrennt.
BeispielBeispiele für Kennungen von Objekttypkomponenten des Objekttyps Material sind:
-
Schlüsselfeld: Material.Material
-
Attribut: Material.Industry
-
Methode: Material.Display
-
Ereignis: Material.Created
-
Bezeichnung
Dies ist ein kurzer sprachenabhängiger Text mit einer Länge von 20 Zeichen. Die Bezeichnung kann auf Bildern oder Dialogfenstern zur Bezeichnung einer Komponente verwendet werden. Bezeichnungen sollen sprachenabhängige Übersetzungen der Kennung der Objekttypkomponente sein. Der Bezeichnung sollte nicht die Kennung des Objekttyps oder der Objektname vorangestellt werden.
Kurzbeschreibung
Die Kurzbeschreibung ist ein erläuternder sprachabhängiger Text mit einer Länge von 80 Zeichen, der in Listen mit Komponenten bzw. für Kurzdokumentationen verwendet werden kann.
Schlüsselfelder
SchlüsselfelderDie Kennung muss ein englisches Substantiv sein.
Wenn die Kennung automatisch durch eine Feldübernahme aus dem ABAP Dictionary erzeugt wird, ist auf jeden Fall eine Nachkontrolle nötig.
Attribute
AttributeDie Kennung muss ein englisches Substantiv sein. Verwenden Sie bei mehrzeiligen Attributen den Plural.
Wenn die Kennung automatisch durch eine Feldübernahme aus dem ABAP Dictionary erzeugt wird, ist auf jeden Fall eine Nachkontrolle nötig. Achten Sie auf Abkürzungen.
Methoden
MethodenDie Kennung muss ein englisches Verb in der Grundform sein. Bezieht sich die Methode auf einen speziellen Aspekt, ein Attribut oder auf ein Teilobjekt, stellen Sie diesen Bezug in der Kennung voran.
Methode ItemAdd
Ereignisse
Die Kennung muss ein englisches Verb sein, das die Zustandsänderung beschreibt.