Web-Programmierung: Style Guide

Namens-Konventionen

Bezeichner setzen sich stets aus ASCII-Buchstaben, Ziffern sowie dem Underscore (_) zusammen.

Groß- uns Kleinschreibung

Paket-Bezeichner

[a-z]+ evtl. [a-z][a-z0-9]*: nur Kleinbuchstaben (Ziffern in Ausnahmefällen)

z.B. wk, model

Klassen-Namen

[A-Z][A-Z0-9]*[a-z][A-Za-z0-9]*: Ein Großbuchstabe gefolgt von beliebigen Buchstaben und Ziffern, mindestens ein Kleinbuchstabe

z.B. Math, ModelBoard

öffentliche Konstanten (Public, Internal, Protected Constants)

[A-Z][A-Z0-9_]*: Ein Großbuchstabe gefolgt von Großbuchstaben, Ziffern und Underscore-Zeichen

z.B. NUMBER_OF_LEVELS, LEVEL1

öffentliche Attribute und öffentliche Methoden (Public, Internal, Protected Members)

[a-z][A-Za-z0-9]*: Ein Kleinbuchstabe gefolgt von beliebigen Buchstaben und Ziffern

z.B. event, user1, allUsers, maxSum

Parameter sowie private Zustandsvariablen, Konstanten und Methoden (Private Members)

[a-z]{1,2}_[a-z0-9_]*: Ein bis zwei Kleinbuchstaben gefolgt von einem Undercore gefolgt von Kleinbuchstaben, Ziffern und Underscore-Zeichen

z.B. p_event, v_user1, sv_all_users, m_max_sum

Kürzel zur Typisierung von Bezeichnern

Klassenbezeichner in Libraries

[A-Z]{1,3}[1m]?([iaces]|es)([A-Z][A-Za-z0-9]*)?

Klassenbezeichner in Libraries setzten sich aus einem Kürzel (maximal drei Großbuchstaben), einer Beschreibung des Bezeichnertyps sowie dem eigentlichen Bezeichner zusammen.

Folgende Arten von Klassenbezeichnenr gibt es:

1: Singleton-Klasse oder -Interface

m: Multiton-Klasse oder -Interface

 

i: Interface

a: abstrakte Klasse

c: (normale) Klasse

e: Enumeration-Klasse

s: Signal-Klasse

es: Enumeration-Klasse mit Signal-Konstanten

Der eigentliche Bezeichner besteht aus ein oder mehreren Bestandteilen, die jeweils mit einem Großbuchstaben beginnen.

Spätere Namensbestandteile beschreiben speziellere Aspekte der Klasse.

z.B. WKcMain, OAS1aModels, WKesModels, WKcModelBoard

Bei WKcModelBoard handelt es sich beispielsweise um eine Klasse (c) in der WK-Library. Sie bescheibt ein Model und zwar ein Model eines Spielbretts (Board). Man muss also ModelBoard als „Spielbrett-Model“, d.h. „Model eines Spielbretts“, und nicht als „Model-Spielbrett“ interpretieren.

Parameter sowie private Zustandsvariablen und private Methoden (Private Members)

s?(p|v|c|l|µ|o|mc)_[a-z][a-z0-9_]*

Folgende Arten von Private-Member-Bezeichnenrn gibt es:

s: Static Member

 

p: Parameter

v: Zustandsvariable

c: Konstante

l: lokale Variable

m: Methode

o: Observer (Event-Listener-Methode)

mc: MovieClip (auf der Flash-Bühne, ist immer public, sollte aber i. Allg. private sein)

Quellen

• Kowarschick, W.: Multimedia-Programmierung