Do’s and Don’ts #3 Naming & Capitalizing
Posted by Michael Morbach
Jan 14
Für einen Entwickler ist es im Alltag immer wichtig einen gut lesbaren und möglichst intuitiven Code zu schreiben. D.h. andere Entwickler sollten schnell verstehen können worum es geht und was welche Methode macht und das ggf. sogar ohne Dokumentation ( auch wenn diese natürlich unverzichtbar ist ). Optimal ist dies der Fall, wenn ein Methodenname so eindeutig ist, dass jeder weiß was sie macht.
Auf folgende Dinge sollten geachtet werden :
- Benutze keine Unterstriche oder ähnliche, nicht alphanumerische, Zeichen
- Benutze möglichst keine Wörter, welche in der Programmiersprache eingebettet sind
- Versuche einfach zu lesende Namen zu verwenden
- Verwende PascalCasing für Namespaces, Klassen, Typen und Methoden sowie Properties
- Verwende camelCasing für Parameter in Methoden und für lokale variablen
DON’T !
public myClass
{
public void method( myclassname valuename )
{
//logik
}
}
DO !
public MyClass
{
public void Method( MyClassName valueName )
{
//logik
}
}
mein Sohn!!!
den Beitrag hast du doch nur für deinen Vater geschrieben. Für meine Erziehung in dieser Hinsicht ist es jetzt möglicherweise zu spät. Aber ich werde mich bemühen.
papa
Diese Erziehung macht doch jeder mal durch
Da sich nur unglaublich wenige Leute an diese Richtlinien halten ( ich ja auch selbst noch bis vor kurzem ) soll dieser Beitrag der Allgemeinheit gelten. Auf das sich vielleicht manch einer denkt das sich dieser kleine Mehraufwand des Aneignens lohnen könnte.
CCD läst grüßen
Hallo Rene,
ich bin mir nicht ganz sicher was du mit CCD meinst. Ich habe grade mal ein wenig gegoogled und vermute stark das du dich auf “Clean Code Developers” beziehst ?
Stimme zu, aber:
1 public MyClass
2 {
3 public void Method(MyClassName parameterName)
4 {
5 // logic
6 }
7 }
… hoffe der Blog formatiert das richtig
Ja, damit wird (hoffentlich) Clean Code Developer gemeint sein.
Siehe dazu auch Golo Rodens Webcast “Codequalität”.
OK, der Blog formatiert es nicht so wie ich’s mir gewünscht hätte, aber ich denke es ist klar, was ich damit meine – die Einrückungen muss man sich denken …
Hallo Harald
Es ist ja nicht so als hätte CCD diese Konventionen erfunden. Ganz ehrlich habe ich zu der Zeit dieses Blogposts noch nicht einmal von CCD gehört. Finde es dennoch eine sehr gute Sache ! valueName sollte in meinem Fall genau wie bei dir parameterName sowieso nur ein Platzhalter für einen richtigen Namen darstellen und sollte lediglich das camelCasing verdeutlichen.
Leider merke ich selbst immer öfter im Programmieralltag auf der Arbeit das man nur selten Zeit für Codequalität findet. Ganz besonder ist dies der Fall wenn man von anderen Programmierern bereits bestehenden Code erweitern soll. Daher gebe ich mir immer besonders viel Mühe meinen Code sauber zu strukturieren und zu kommentieren. Für meinen privat geschriebenen Code kann ich mir immer die Zeit für Codequalität nehmen.
Gruß Micha