Cheatography
https://cheatography.com
Ein Cheat-Sheet um die Benamung unseres Source-Codes für alle Entwickler gleich zu halten und neue Entwickler leichter heranzuführen.
This is a draft cheat sheet. It is a work in progress and is not finished yet.
Generelles
Do |
Don't |
Benutze leicht lesbare Bezeichnernamen. Lesbarkeit ist kürze vorzuziehen. |
Benutzen von Unter. oder Bindestrichen |
Verzichte, wo möglich auf Akronyme und wenn dann verwende weit verbreitete. |
Abkürzungen in Bezeichnernamen |
Code wird auf Deutsch geschrieben |
Übersetzen von typischen C#-Bezeichnungen (z.B. Get/Set) |
Enums
Verzichte auf Prä- und Suffixe |
Der Name ist üblicherweise Plural (Bsp.: Teams, Kunden) |
Groß- und Kleinschreibungsregeln
Typ |
Regel |
Lokale Variable |
lowerCamelCase |
Parameter |
lowerCamelCase |
private field |
lowerCamelCase |
public field |
UpperCamelCase |
protected field |
UpperCamelCase |
internal field |
UpperCamelCase |
Property |
UpperCamelCase |
Method |
UpperCamelCase |
Class |
UpperCamelCase |
Konstante |
UpperCamelCase |
Interface |
IUpperCamelCase |
|
|
Parameter
Wähle den Namen so, dass klar ist welche Daten beeinflusst werden. |
Positiv-Beispiel: warenkorbSumme |
Negativ-Beispiel: decimalSumme |
Typ-Regeln
Fields |
Typischerweise Nomen oder Nominalgruppen z.B. gehalt |
Properties |
Nomen, Nominalgruppen oder Adjektive |
Eigenschaften und Get-Methoden sollten nicht den selben Namen haben |
Boolesche Eigenschaften sollten mit Ist oder Hat beginnen |
Methoden |
Typischerweise werden Verben verwendet z.B. SchreibeDaten |
Events (Bsp. Closing) |
Typischerweise werden Verben verwendet |
Bei Event-Handlern, sollten die Parameter sender
und e
verwendet werden |
Ob vor oder nach einem Event muss im Namen wiederzufinden sein Bsp.: Closed, Closing |
|
