Code Guidelines / Kodierrichtlinien - Clean Code nach Anleitung

Code Guidelines bzw. Kodierrichtlinien helfen dabei, einheitlichen Quellcode zu schreiben und steigern somit die Analysierbarkeit, Wartbarkeit und Modifizierbarkeit Eures Quellcodes - nach Vorbild von Clean Code. Kurz: mit Code Guidelines könnt Ihr besser programmieren und einheitlicher programmieren! Nachdem Ihr hier oft nach Code Guidelines gefragt hab, widmen wir heute mal eine ganze Folge dem Thema Code Guidelines. Warum benötigt ihr eine Code Guideline? Was sollte in eine Kodierrichtlinie hinein? Was solltet Ihr im laufenden Projekt bei Code Guidelines berücksichtigen? Alle diese Fragen und noch mehr, beantworten wir in dieser Folge!

## Kapitel
00:00 Begrüßung
01:43 Warum Code Guidelines?
03:25 Wer benötigt Code Guidelines?
05:17 Wann werden Code Guidelines benötigt?
07:07 Was gehört in eine Code Guideline?
10:12 Wo gibt es Vorlagen für Code Guidelines?
11:59 Code Guidelines in der Praxis

## Links zu Code Guidelines:

▬ Über diesen Kanal ▬▬▬▬▬▬▬▬▬▬▬▬

Seit vielen Jahren arbeite ich als Consultant, Coach und Trainer für professionelle Softwareentwicklung mit den Schwerpunkten Softwarequalität, Softwarearchitektur sowie Prozessmanagement. Auf meinem Kanal möchte ich Euch mein Wissen und meine langjährige Erfahrung in diesen Bereichen vermitteln - natürlich kostenlos. Dabei versuche ich stets Euch das Wissen so zu vermitteln, dass Ihr damit direkt in der Praxis loslegen könnt und das ganze immer mit guten Portion Humor. Lernen soll ja schließlich Spaß machen :)

▬ Empfohlene Videos ▬▬▬▬▬▬▬▬▬▬▬▬

▬ Wichtige Links ▬▬▬▬▬▬▬▬▬▬▬▬

▬ Social Media ▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬

▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬▬

[DavidTielke]

Schreibt gerne mal in die Kommentare, wie Ihr das mit Code Guidelines seht. Verwendet Ihr bereits Code Guidelines? Und wenn ja, werden sie akzeptiert und wlchen Umfang haben Sie? Ich bin gespannt... :) Und solltet ihr den Kanal noch *nicht abonniert* haben, macht das doch bitte :)

[DagarCoH]

Danke für das Video. Werde ich bei uns dann auch mal anstoßen, da das Software-Team sich wohl bald verdoppeln wird (von 1 auf 2 Entwickler).
Kleine Anmerkung: beim englischen "debt" ist das b stumm

[andrekirst]

Ich finde Coding Guidelines extremst wichtig. Zum einen geht es ja um das gleiche Verständnis con Quellcode. Wenn ich z.B. folgendes lese: "variable = Text;", weiß ich, dass links eine Variable innerhalb einer Methode ist und rechts eine Eigenschaft. Ohne zu der Definition desjeweiligen zu gehen. Der andere Punkt ist, wenn es alle anders machen und man immer hinterher ist, seine eigenen Richtlinien zu schaffen bzw. zu übernehmen, hast du unnötige Codeänderungen und somit mehr Aufwand bei einem Review. Am Ende macht der Code das gleiche, aber die Änderung an den Richtlinien hält auf. Zum Glück gibt es Resharper und .editorconfig, die da ein wenig Einhalt gebieten, was ich gut finde.

[christofgentzmer]

Es gibt doch ein offizielles Buch (für .net) dazu: Framework Design Guidelines von Anders Heilsberg. Das "goldene Buch" für uns.

[stefanalpers]

Ein Thema, dessen Umsetzung stark von der Einstellung und Bereitschaft der Kollegen abhängt, sich kontinuierlich weiterzubilden und neue Dinge nach kritischer Begutachtung zu verwenden oder eben nicht.

Man könnte Schleifen ja immer noch mit GOTO machen aber wahrscheinlich jeder sieht ein, dass es heute bessere Sprachkonstrukte gibt.

[hubertfuchs]

Bei uns sind die Coderichtlinien schon etwas älter(ein paar Punkte, wie man vor 20 Jahres Software entwickelt hat) und es wird nicht mehr alles erst genommen was darin steht.
Ich habe erfolgreich ein Mindmap zu diesem Video erstellt... das ist wirklich sehr hilfreich um sich noch mehr wichtige und hilfreiche Punkte zu merken.
Mir ist auch gleich ein Fehler aufgefallen :)) bei "Wo gibt es die Vo_r_lagen". Da fehlt das "r" ;-))
Nützlich für mich fand ich auch den Tipp die Nummer der Regel ggf. in der Code Review anzugeben.
Danke.

[Marco_M]

Hallo David,

für unser Entwicklungsteam ein sehr aktuelles Thema. Wir sind bei uns gerade dran unsere Code Guidelines nach langem einmal wieder zu überarbeiten und für alle verständlich zu machen. Es wurde leider nicht konsequent verfolgt und somit haben wir jetzt verschiedene Stile in unseren zwei seit über 10 Jahren gewachsenen Produkten.
Ich werde morgen auch noch einmal intern das Thema mit Button vs. btn und Textbox vs. txt anbringen. Wie ist deine Meinung zu den Abkürzungen bei Controls? Lieber die Klassen komplett ausschreiben und längere Variablen Namen riskieren oder kurz und ggf. nicht so schnell lesbar, aber „übersichtlicher“ gestalten?
Dann haben wir bei uns dem Punkt Felderprefix. Früher wurde viel mit „m_fieldName“, dann mit „_fieldName“ und jetzt mit „this.fieldName“ umgesetzt (Wenn ich mich nicht irre auch eine Empfehlung von Microsoft). Ich bin aktuell immer noch ein Fan von „_fieldName“ da es übersichtlicher (kürzer) und schneller als ein "this.fieldName" zu tippen ist. Wie ist hier deine Meinung?


Beste Grüße und vielen Dank für deinen Einsatz
Marco

[heischono]

Ich habe vor einiger Zeit selbst Kodierrichtlinien erstellt, die für unser kleines 2-Leute-Team gelten sollen. Dann habe ich meinen Chef (bei uns wörtlich übersetzt "Fachverantwortlicher") darauf angesprochen, wie er es denn hält mit solchen Richtlinien. Seine Reaktion hat mich überrascht, er sieht darin keinen Sinn weil sowieso jeder macht was er will und die Richtlinien als unnötige Einschränkung empfunden werden. Da liegt noch ne Menge Arbeit vor uns! Ich werde im neuen Jahr mal direkt zum Big Boss gehen, und ihm erklären worum es geht. Er will schließlich alle Entwickler überall einsetzen können, da sollten Kodierrichtlinien absolute Top-Priorität haben. Andererseits kann man ja mit diesen Richtlinien kein schnelles Geld auf direktem Wege machen ...
Mal sehen wie das ausgeht. VG, Heiko

[andreweinert]

Der schlimmste Kommentar zum Thema Kodierrichtlinien: "Ich mache das seit 15 Jahren so, warum soll ich mich jetzt ändern!"
Ansonsten werde ich deine Anmerkungen mal in meine einfließen lassen.