PROGRAMMIERUNG / CLEAN CODE

Transkript

1 5. Kapitel PROGRAMMIERUNG / CLEAN CODE S#waretechnik Prf. Dr. Wlfgang Schramm

2 Übersicht 1 1. Einführung in das Sftware Engineering 2. Sftwareprzesse 3. Anfrderungsanalyse und -Spezifikatin 4. Sftwareentwurf 5. Prgrammierung 6. Sftware-Qualitätssicherung und -Prüfung 7. Knfiguratinsverwaltung 8. Sftware-Wartung

3 Implementierung 2 Idee!!! Entwurf vn Algrithmus und Datenbank, Hardware Knfiguratin Benutzung System-Entwicklung Prblemdefinitin, funktinale Analyse System-Analyse

4 Prgrammierung 3 Prgramming is a craft. It is dependent n individual skill, attentin t detail, and knwledge f hw t use available tls in the best way. Craftsmen must knw their materials, understand the principles f their craft and learn by experience. Thus, prgrammers must understand bth hst and target cmputer systems, must knw sme thery f prgramming and must practice prgramming. [Sm06]

5 4 Wichtige Eigenschaften vn Prgrammiersprachen Strukturelemente zur Knstruktin mdularer Prgrammeinheiten. Trennung vn Schnittstelle und Implementierung. Mächtiges Typsystem mit strenger Typprüfung. Syntax, die zur Lesbarkeit des Cdes beiträgt. Autmatische Zeigerverwaltung. Ausnahmebehandlung.

6 Inhalt 5 1. Mtivatin 2. Beispiele und Empfehlungen 3. Ursachen und Knsequenzen 4. Abhilfe schaffen am Beispiel Antni Fil

7 Fragerunde 6 Was fällt Ihnen zu dem Begriff "Cde-Qualität" ein? Was hat psitiven, was negativen Einfluss auf die Qualität vn Cde? Warum? Suriya Dnavanik

8 Wie kmmt es überhaupt zu schlechtem Cde? 7 Zu Beginn eines Prjekts "auf der grünen Wiese" ist die Cde-Qualität (meist) gut und sauber (clean). Schlechter wird die Cde-Qualität vn alleine: Sftware(-Lösungen) wachsen und werden zunehmend kmplexer. Änderungen schaden der (initial klaren) Struktur. Zeitdruck führt zu nicht-idealen Lösungen. Kurzfristige Lösungen werden nie verbessert. Prgrammteile werden zweckentfremdet. Kmmentare werden nicht aktualisiert. Dinge/Gründe, die zu Beginn nch "klar waren", werden vergessen.

9 Inhalt 8 1. Mtivatin 2. Beispiele und Empfehlungen 3. Ursachen und Knsequenzen 4. Abhilfe schaffen am Beispiel Antni Fil

10 Regeln für die Prgrammierung 1/2 9 Richtlinien Wie sind die Bezeichner zu wählen. Wie ist das Layut zu gestalten. Wie sind die Schnittstellen zu gestalten (glbale Variablen, Reihenflge der der Parameter). Was/Wie muss kmmentiert werden. Beispiele: GNU Cding Standard, Java Cding Style Guide Umfang vn Hauptprgramm, Przeduren, Paketen in LOC. Anzahl vn Attributen pr Klasse. Anzahl öffentlicher Methden pr Klasse. Umfang einer Daten (Klasse).

11 Regeln für die Prgrammierung 2/2 10 Ratschläge (nach Fairley [Fai85]) Dn t be t clever. Avid null Then-statements and Avid Then-If-statements. Dn t nest t deepley. Avid bscure side effects... Avid side effects. Dn t subptimize. Rutines having mre than five parameters? Dn t use an identifier fr multiple purpses. Ergänzung Lgische Aussagen s einfach wie möglich halten. Text- und Zahlenliterale (außer 0 und 1) gehören nicht in das Prgramm. Jedes Prgramm muss ausreichend kmmentiert sein. if nt (Bildschirmausgabe r DruckerAusgeschaltet) then.

12 Prgramm-Dkumentatin 11 Make the cde as clear as pssible t reduce the need fr cmments. Never repeat infrmatin in a cmment that is readily available in the cde. Where a cmment is required, make it cncise and cmplete. Use prper grammar and spelling in cmments. Make cmments visually distinct frm the cde. Structure cmments in headers s that the infrmatin can be autmatically extracted by a tl.

13 Kmmentare Arten 12 Kpfkmmentare: am Anfang vn Prgrammeinheiten (Mdule, Klassen u.ä.). Eingeschbene Kmmentare: erläutern Zeilen der Abschnitte einer Prgrammeinheit. Erläuterungen: kurze Beschreibung z.b. bei Deklaratin der Wertzuweisung.

14 Kmmentare Beispiel Kpfkmmentar 13 Verfasser und Datum. Prgrammiersprache und Cmpiler (mit Versinsangaben). Umgebung (verwendete System-Sftware). Kurzbeschreibung. Beziehung zu anderen Prgrammeinheiten (i.s.v. Benutzung). Verweise auf externe Dkumente. Verfasser, Datum, Anlass und Auswirkung vn Änderungen (sfern nicht durch ein eingesetztes Versinsverwaltungssystem geliefert).

15 Rbuste Prgramme 14 The degree t which a system r a cmpnent can functin crrectly in the presence f invalid inputs r stressful envirnmental cnditins. è Der Cde sllte auf viele mögliche Fehlersituatinen reagieren: è è Fehlerhafte Bedienung durch den Anwender. Fehlerhafte Umgebungssituatin. Anteil des Cdes für Fehlerbehandlung: 25% - 50%

16 Werkzeuge zur Prgrammentwicklung 15 Syntax-gesteuerter Editr: zum Erzeugen und Anzeigen syntaktischer Strukturen und Erkennung einfacher Fehler. Werkzeug, welches den Übersetzungs- und Bindeprzess steuert. Werkzeug für die Verwaltung der Quellprgramme, auch aller anderen Sftwareeinheiten und ihrer Knfiguratinen (Bsp.: make, ant). Werkzeuge, welche den Test unterstützen und die Testüberdeckung messen (Bsp.: JUnit). Werkzeug, welches den Cde bezüglich der der Cdierregeln prüft (Bsp.: Java CheckStyle). Debugger, zur Fehlersuche auf der untersten Ebene.

17 Ein Beispiel für schlechten Cde 16 Was stört Sie (hffentlich) an flgendem Prgrammcde: Was können Sie tun, um slche Cdefragmente zu vermeiden? Wie würde die Methde dann aussehen?

18 Ein Beispiel für schlechten Cde: Fehlercdes 17 Die bessere Variante:

19 18 Ein Beispiel für schlechten Cde: null als Parameter Eine Methde akzeptiert zwei Punkte als Parameter: Was passiert, wenn sie mit null aufgerufen wird: Eine Möglichkeit, mit diesem Parameter umzugehen: Eine andere Möglichkeit, mit diesem Parameter umzugehen:

20 19 Ein Beispiel für schlechten Cde: null als Parameter Eine Methde akzeptiert zwei Punkte als Parameter: Was passiert, wenn sie mit null aufgerufen wird: Das Prblem bleibt bestehen: Es wird eine Exceptin/ein Fehler ausgelöst Eine Möglichkeit, mit diesem Parameter umzugehen: à Lösung: Disziplin Übergeben Sie nie null als Parameter! Eine andere Möglichkeit, mit diesem Parameter umzugehen:

21 20 Ein Beispiel für schlechten Cde: Output- Parameter Was vermuten Sie, tut die flgende Prgrammzeile: wenn Sie das Ppup dazu sehen? Wie sllte diese Zeile stattdessen geschrieben werden?

22 21 Ein Beispiel für schlechten Cde: Output- Parameter Was sagt Ihnen die flgende Prgrammzeile: wenn Sie das Ppup dazu sehen? à Empfehlung: Vermeiden Sie Seiteneffekte durch Output-Parameter! à Zustandsänderungen an einem Objekt sllten nur durch Methden dieses Objekts vrgenmmen werden! Wie sllte diese Zeile geschrieben sein?

23 22 Trennen vn Anweisungen und Abfragen Was tut (vermutlich) die Methde set im flgenden Beispiel: Empfehlung: Trennen Sie immer Anweisungen vn Abfragen, zum Beispiel:

24 Ble'sche Parameter vermeiden 23 Was tut (vermutlich) der flgende Aufruf: wenn Sie das Ppup dazu sehen? Wie könnte eine bessere Lösung aussehen? Empfehlung: Verwenden Sie zwei Methden mit aussagekräftigen Namen!

25 Diskussin 24 Diskutieren Sie flgende Behauptungen zu Kmmentaren: Wenn wir uns mittels Prgrammcde gut genug ausdrücken könnten, würden wir keine Kmmentare brauchen Kmmentare sind kein Ersatz für schlechten Cde Ein Kmmentar bekräftigt unsere Unfähigkeit, guten Cde zu schreiben Art Teräs

26 Kmmentare vs. guter Cde 25 Welches Prgramm würden Sie lieber lesen, dieses hier: der dieses:

27 26 Pfadfinder-Regel Hinterlassen Sie Prgrammcde immer etwas aufgeräumter als Sie ihn vrgefunden haben! frei nach Rbert Stephensn Smyth Baden- Pwell

28 Inhalt Mtivatin 2. Beispiele und Empfehlungen 3. Ursachen und Knsequenzen 4. Abhilfe schaffen am Beispiel Antni Fil

29 Fragerunde 28 Welche Auswirkungen kann (besnders) guter Cde haben? Welche Auswirkungen kann (besnders) schlechter Cde haben? Suriya Dnavanik

30 Wie kmmt es überhaupt zu schlechtem Cde? 29 Zu Beginn eines Prjekts "auf der grünen Wiese" ist die Cde-Qualität (meist) gut und sauber (clean) Schlechter wird die Cde-Qualität vn alleine Sftware(-Lösungen) wachsen und werden zunehmend kmplexer Änderungen schaden der (initial klaren) Struktur Zeitdruck führt zu nicht-idealen Lösungen Kurzfristige Lösungen werden nie verbessert Prgrammteile werden zweckentfremdet Kmmentare werden nicht aktualisiert Dinge/Gründe, die zu Beginn nch "klar waren", werden vergessen

31 30 Wie kmmt es zu schlechtem Cde: Metapher What s the fastest way t be dne with dinner? Get up frm the table and nt d the clean up. When it is time t eat we just find the cleanest dishes and when dinner is ver we leave the dishes dirty again. Eventually it is s hard t make dinner we utsurce dinner. Sushi chefs clean as they prepare fd. If yu want t g fast g as clean as yu can. The nly way t g fast is t g clean. [Rbert C. "Uncle Bb" Martin]

32 Fragerunde 31 Wie misst man die Qualität vn Cde? Suriya Dnavanik

33 32

34 Inhalt Mtivatin 2. Beispiele und Empfehlungen 3. Ursachen und Knsequenzen 4. Abhilfe schaffen am Beispiel Antni Fil Mtivatin Beispiele und Empfehlungen Ursachen und Knsequenzen Abhilfe schaffen

35 Fragerunde 34 Was kann man gegen schlechten Cde tun? Suriya Dnavanik Mtivatin Beispiele und Empfehlungen Ursachen und Knsequenzen Abhilfe schaffen

36 36 Refactring am Beispiel

37 37 F R A G E N phtgraphy: wdleywnderwrks art wrk: Peter Kaiser

38 Quellen 38 Rbert C. Martin: Clean Cde: A Handbk f Agile Sftware Craftsmanship, Prentice Hall Internatinal, 2008 Object Mentr: Martin Fwler: Imprving the Design f existing Cde, Addisn-Wesley Lngman, 2002