Web-Programmierung: Style Guide: Unterschied zwischen den Versionen
aus GlossarWiki, der Glossar-Datenbank der Fachhochschule Augsburg
Kowa (Diskussion | Beiträge) |
Kowa (Diskussion | Beiträge) |
||
Zeile 9: | Zeile 9: | ||
: z.B. <code>wk</code>, <code>model</code> | : z.B. <code>wk</code>, <code>model</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 | : <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> | : z.B. <code>NUMBER_OF_LEVELS</code>, <code>LEVEL1</code> | ||
Zeile 21: | Zeile 21: | ||
: z.B. <code>p_event</code>, <code>v_user1</code>, <code>sv_all_users</code>, <code>m_max_sum</code> | : z.B. <code>p_event</code>, <code>v_user1</code>, <code>sv_all_users</code>, <code>m_max_sum</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 | : <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> | : z.B. <code>event</code>, <code>user1</code>, <code>allUsers</code>, <code>maxSum</code> |
Version vom 18. Oktober 2010, 08:12 Uhr
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
- ö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
- 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
- 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
- ö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
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 eus einem Krüzel (maximal drei Großbuchstaben), einer Art-Beschreibung sowie dem eigentlichen Bezeichner zusammen.
- Folgende Arten von Klassenbezeichnenr gibt es:
1
: Singleton-Klasse oder -Interfacem
: Multiton-Klasse oder -Interfacei
: Interfacea
: abstrakte Klassec
: (normale) Klassee
: Enumeration-Klasses
: Signal-Klassees
: 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 derWK
-Library. Sie bescheibt ein Model und zwar ein Model eines Spielbretts (Board
). Man muss alsoModelBoard
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)_[a-z][a-z0-9_]*
- Folgende Arten von Private-Member-Bezeichnenrn gibt es:
s
: Static Memberp
: Parameterv
: Zustandsvariablec
: Konstantel
: lokale Variableo
: Observer (Event-Listener)