Quelltext der Seite Web-Programmierung: Style Guide

{{Qualität
|correctness         = 4
|extent              = 4
|numberOfReferences  = 5
|qualityOfReferences = 5
|conformance         = 5
}}
==Namenskonventionen==

Bezeichner setzen sich stets aus [[ASCII]]-Buchstaben, Ziffern sowie dem Underscore (<code>_</code>) zusammen.

=== Groß- uns Kleinschreibung ===

; Paket-Bezeichner
: <code>[a-z]+</code> evtl. <code>[a-z][a-z0-9]*</code>: nur Kleinbuchstaben (Ziffern in Ausnahmefällen)
: z.B. <code>wk</code>, <code>model</code>

; Klassennamen und Projektnamen
: <code>[A-Z][A-Za-z0-9]*</code>: Ein Großbuchstabe gefolgt von beliebigen Buchstaben und Ziffern ([[CamelCase]])
: z.B. <code>Math</code>, <code>ModelBoard</code>

; öffentliche Konstanten (Public, Internal, Protected Constants)
: <code>[A-Z][A-Z0-9_]*</code>: Ein Großbuchstabe gefolgt von Großbuchstaben, Ziffern und Underscore-Zeichen
: z.B. <code>NUMBER_OF_LEVELS</code>, <code>LEVEL1</code>

; öffentliche Attribute und öffentliche Methoden (Public, Internal, Protected Members)
: <code>[a-z][A-Za-z0-9]*</code>: Ein Kleinbuchstabe gefolgt von beliebigen Buchstaben und Ziffern
: z.B. <code>event</code>, <code>user1</code>, <code>allUsers</code>, <code>maxSum</code>

; JavaScript, Flash und Flex: öffentlich zugängliche Objekte: <code>DisplayObject</code> (<code>Sprite</code>, <code>MovieClip</code>, Flex-Komponenten etc.)
: <code>[d][A-Z][A-Za-z0-9]*</code>: <code>d</code> gefolgt von einem Großbuchstaben gefolgt von beliebigen Buchstaben und Ziffern
: z.B. <code>dButtonStart</code>, <code>dButterfly</code>

; Flash: öffentlich zugängliche Frame-Labels
: <code>[lb][A-Z][A-Za-z0-9]*</code>: <code>lb</code> gefolgt von einem Großbuchstaben gefolgt von beliebigen Buchstaben und Ziffern
: z.B. <code>lbStart</code>, <code>lbEnd</code>

; Parameter sowie private Zustandsvariablen, Konstanten und Methoden (Private Members) sowie <code>DisplayObject</code>s und Labels, die nicht öffentlich zugänglich sein sollten (es aber trotzdem sind)
: <code>[a-z]{1,2}_[a-z0-9_]*</code>: Ein bis zwei Kleinbuchstaben gefolgt von einem Undercore gefolgt von Kleinbuchstaben, Ziffern und Underscore-Zeichen
: z.B. <code>p_event</code>, <code>v_user1</code>, <code>sv_all_users</code>, <code>m_max_sum</code>, <code>d_butterfly</code>, <code>lb_start</code>

=== Kürzel zur Typisierung von Bezeichnern ===

;Klassennamen in Libraries
:<code>[A-Z]{1,3}[1m]?([iaces]|es)([A-Z][A-Za-z0-9]*)?</code>
: Klassenbezeichner in Libraries setzten sich aus einem Kürzel des Namens der Biliothek (maximal drei Großbuchstaben), einer Beschreibung des Bezeichnertyps sowie dem eigentlichen Bezeichner zusammen.
: Die „Beschreibung des Bezeichnertyps“ besteht aus einem oder zwei Buchstaben:
:: <code>i</code>: [[Interface]]
:: <code>a</code>: [[abstrakte Klasse]]
:: <code>c</code>: (normale) [[Klasse]]
:: <code>e</code>: [[Enumeration]]-Klasse
:: <code>s</code>: [[Signal]]-Klasse
:: <code>es</code>: Enumeration-Klasse mit Signal-Konstanten
: Singleton- oder Multiton-Klassen werden mit einen zusätzlichen Buchstaben gekennzeichnet:
:: <code>1</code>: Singleton-Klasse oder -Interface
:: <code>m</code>: Multiton-Klasse oder -Interface
:: &nbsp;
: Der eigentliche Bezeichner besteht aus ein oder mehreren Bestandteilen, die jeweils mit einem Großbuchstaben beginnen.
: Spätere Namensbestandteile beschreiben speziellere Aspekte der Klasse.
:Beispiele; <code>WKcMain</code>, <code>OASa1Models</code>, <code>WKesModels</code>,  <code>WKcModelBoard</code>
: Bei <code>WKcModelBoard</code> handelt es sich beispielsweise um eine Klasse (<code>c</code>) in der <code>WK</code>-Library. Sie bescheibt ein [[Model-View-Controller-Paradigma/Model|Model]] und zwar ein Model eines Spielbretts (<code>Board</code>). Man muss also <code>ModelBoard</code> als „Spielbrett-Model“, d.h. „Model eines Spielbretts“, und nicht als „Model-Spielbrett“ interpretieren.

;Parameter sowie private Zustandsvariablen und private Methoden (Private Members)
: <code>(s?(p|v|l|m|o)|c|d|lb)_[a-z][a-z0-9_]*</code>
: Folgende Arten von Private-Member-Bezeichnenrn gibt es:
:: <code>s</code>: [[Static Member]]
:: &nbsp;
:: <code>p</code>: [[Parameter]]
:: <code>v</code>: [[Zustandsvariable]]
:: <code>l</code>: [[lokale Variable]]
:: <code>g</code>: [[globale Variable]] (sollte möglichst vermieden werden)
:: <code>m</code>: [[Methode]]
:: <code>o</code>: [[Observer]] (Event-Listener-Methode)
:: &nbsp;
:: <code>c</code>: [[Konstante]] (unabhängig davon, ob als <code>private const</code> oder <code>private static const</code> definiert)
:: <code>d</code>: [[DisplayObject]]: ein grafisches Objekt auf einer JavaScript-Bühne, der Flash-Bühne (das als <code>private</code> angesehen werden soll, obwohl es <code>public</code> sein muss) oder in einer Flex-Komponente
:: <code>lb</code>: Frame-Label in einem Flash-<code>MovieClip</code> der als <code>private</code> angesehen werden soll (obwohl er <code>public</code> ist)

Darüber hinaus werden die Variablen <code>i</code>, <code>j</code> und <code>k</code> als Integer-Laufvariablen verwendet, auch wenn dies nicht der obigen Namenskonvention entspricht.

==Quellen==
<noinclude>
# {{Quelle|Kowarschick, W.: Web-Programmierung}}</noinclude><noinclude>[[Kategorie:Kapitel:Multimedia-Programmierung:Beispiele]]
</noinclude>