CleanCode: Unterschied zwischen den Versionen
Keine Bearbeitungszusammenfassung |
Malte (Diskussion | Beiträge) Keine Bearbeitungszusammenfassung |
||
| Zeile 6: | Zeile 6: | ||
=== Prinzipien === | === Prinzipien === | ||
===== [http:// | ===== [http://clean-code-developer.de/die-grade/roter-grad/#Dont_Repeat_Yourself_DRY Don't repeat yourself (DRY)] ===== | ||
Kopierter Code leistet Inkonsistenzen Vorschub und führt zu einem mehr an Fehleranfälligkeit und Arbeit. Kein Copy & Paste sondern mehrfach verwendeten Code in Funktionen und/oder Klassen auslagern. | Kopierter Code leistet Inkonsistenzen Vorschub und führt zu einem mehr an Fehleranfälligkeit und Arbeit. Kein Copy & Paste sondern mehrfach verwendeten Code in Funktionen und/oder Klassen auslagern. | ||
[http://programmer.97things.oreilly.com/wiki/index.php/Don%27t_Repeat_Yourself → mehr dazu] | [http://programmer.97things.oreilly.com/wiki/index.php/Don%27t_Repeat_Yourself → mehr dazu] | ||
===== [http:// | ===== [http://clean-code-developer.de/die-grade/roter-grad/#Keep_it_simple_stupid_KISS Keep it simple, stupid (KISS)] ===== | ||
Einfache Lösungen sind immer zu bevorzugen. Zerlege komplizierte Probleme in Teilprobleme, bis die Teilprobleme nicht weiter zerlegbar sind. | Einfache Lösungen sind immer zu bevorzugen. Zerlege komplizierte Probleme in Teilprobleme, bis die Teilprobleme nicht weiter zerlegbar sind. | ||
[http://people.apache.org/~fhanik/kiss.html → mehr dazu] | [http://people.apache.org/~fhanik/kiss.html → mehr dazu] | ||
===== [http:// | ===== [http://clean-code-developer.de/die-grade/roter-grad/#Vorsicht_vor_Optimierungen Beware of Optimizations] ===== | ||
Optimierung bedeutet Aufwand und komplexeren Code. Solange es nicht WIRKLICH notwendig ist, sollte man darauf verzichten. | Optimierung bedeutet Aufwand und komplexeren Code. Solange es nicht WIRKLICH notwendig ist, sollte man darauf verzichten. | ||
| Zeile 28: | Zeile 28: | ||
[http://cowboyprogramming.com/2007/01/05/evolve-your-heirachy/ → mehr dazu] | [http://cowboyprogramming.com/2007/01/05/evolve-your-heirachy/ → mehr dazu] | ||
===== [http:// | ===== [http://clean-code-developer.de/die-grade/orangener-grad/#Single_Responsibility_Principle_SRP Single Responsibility Principle (SRP)] ===== | ||
Eine Klasse sollte genau eine Aufgabe erfüllen. | Eine Klasse sollte genau eine Aufgabe erfüllen. | ||
[http://programmer.97things.oreilly.com/wiki/index.php/The_Single_Responsibility_Principle → mehr dazu] | [http://programmer.97things.oreilly.com/wiki/index.php/The_Single_Responsibility_Principle → mehr dazu] | ||
===== [http:// | ===== [http://clean-code-developer.de/die-grade/orangener-grad/#Separation_of_Concerns_SoC Separation of Concerns (SoC)] ===== | ||
Zerteile ein Programm in unterschiedliche Bereiche (eigentlich auf Klassenebene, aber auch auf Komponentenebene anwendbar), die jeweils eine Aufgabe haben und die sich so wenig wie möglich überlappen. | Zerteile ein Programm in unterschiedliche Bereiche (eigentlich auf Klassenebene, aber auch auf Komponentenebene anwendbar), die jeweils eine Aufgabe haben und die sich so wenig wie möglich überlappen. | ||
[http://weblogs.asp.net/arturtrosin/archive/2009/01/26/separation-of-concern-vs-single-responsibility-principle-soc-vs-srp.aspx → mehr dazu] | [http://weblogs.asp.net/arturtrosin/archive/2009/01/26/separation-of-concern-vs-single-responsibility-principle-soc-vs-srp.aspx → mehr dazu] | ||
===== [http:// | ===== [http://clean-code-developer.de/die-grade/orangener-grad/#Source_Code_Konventionen Coding Conventions] ===== | ||
[[Coding Conventions]] sind für die Zusammenarbeit mehrerer Entwickler an einem größeren Softwareprojekt unverzichtbar. Sie erhöhen die Lesbarkeit und sorgen für Konsistenz im Quellcode. Im Softwarepraktikum wird die Einhaltung der [[Coding Conventions]] durch [[Resharper]] unterstüzt. | [[Coding Conventions]] sind für die Zusammenarbeit mehrerer Entwickler an einem größeren Softwareprojekt unverzichtbar. Sie erhöhen die Lesbarkeit und sorgen für Konsistenz im Quellcode. Im Softwarepraktikum wird die Einhaltung der [[Coding Conventions]] durch [[Resharper]] unterstüzt. | ||
[http://en.wikipedia.org/wiki/Coding_conventions → mehr dazu] | [http://en.wikipedia.org/wiki/Coding_conventions → mehr dazu] | ||
===== [http:// | ===== [http://clean-code-developer.de/die-grade/gelber-grad/#Interface_Segregation_Principle_ISP Interface Segregation Principle (ISP)] ===== | ||
Interfaces sollen so klein wie möglich sein und nur beinhalten was auch wirklich benötigt wird. | Interfaces sollen so klein wie möglich sein und nur beinhalten was auch wirklich benötigt wird. | ||
[http://ifacethoughts.net/2006/03/28/interface-segregation-principle/ → mehr dazu] | [http://ifacethoughts.net/2006/03/28/interface-segregation-principle/ → mehr dazu] | ||
===== [http:// | ===== [http://clean-code-developer.de/die-grade/gelber-grad/#Dependency_Inversion_Principle Dependency Inversion Principle (DIP)] ===== | ||
Entkopple Module über Interfaces: | Entkopple Module über Interfaces: | ||
* Module hoher Ebenen sollten nicht von Modulen niedriger Ebenen abhängen. Beide sollten von Abstraktionen abhängen. | * Module hoher Ebenen sollten nicht von Modulen niedriger Ebenen abhängen. Beide sollten von Abstraktionen abhängen. | ||
| Zeile 55: | Zeile 55: | ||
[http://lostechies.com/gabrielschenker/2009/01/30/the-dependency-inversion-principle/ → mehr dazu] | [http://lostechies.com/gabrielschenker/2009/01/30/the-dependency-inversion-principle/ → mehr dazu] | ||
===== [http:// | ===== [http://clean-code-developer.de/die-grade/gelber-grad/#Liskov_Substitution_Principle Liskov Substitution Principle (LSP)] ===== | ||
Subtypen müssen sich so verhalten wie ihr Basistyp. Z.B. darf eine Methode, die im Basistyp keine Exception wirft, auch im Subtyp keine Exception werfen. | Subtypen müssen sich so verhalten wie ihr Basistyp. Z.B. darf eine Methode, die im Basistyp keine Exception wirft, auch im Subtyp keine Exception werfen. | ||
| Zeile 62: | Zeile 62: | ||
[http://www.oodesign.com/liskov-s-substitution-principle.html → mehr dazu] | [http://www.oodesign.com/liskov-s-substitution-principle.html → mehr dazu] | ||
===== [http:// | ===== [http://clean-code-developer.de/die-grade/gelber-grad/#Information_Hiding_Principle Information Hiding Principle] ===== | ||
Eine Klasse sollte nur die für die Schnittstelle notwendigen Methoden und Felder öffentlich zur Verfügung stellen. Durch das Verbergen der Implementierungsdetails wird die Benutzung der Klasse von ihrer Implementierung unabhängig gemacht. | Eine Klasse sollte nur die für die Schnittstelle notwendigen Methoden und Felder öffentlich zur Verfügung stellen. Durch das Verbergen der Implementierungsdetails wird die Benutzung der Klasse von ihrer Implementierung unabhängig gemacht. | ||
[http://en.wikipedia.org/wiki/Information_hiding → mehr dazu] | [http://en.wikipedia.org/wiki/Information_hiding → mehr dazu] | ||
===== [http:// | ===== [http://clean-code-developer.de/die-grade/gelber-grad/#Principle_of_Least_Astonishment Principle of Least Astonishment] ===== | ||
Programmteile sollten sich so verhalten, "wie man es erwartet". Funktionen sollten sich ihrem Namen entsprechend verhalten und Seiteneffekte sollten klar ersichtlich und gut dokumentiert sein. | Programmteile sollten sich so verhalten, "wie man es erwartet". Funktionen sollten sich ihrem Namen entsprechend verhalten und Seiteneffekte sollten klar ersichtlich und gut dokumentiert sein. | ||
[http://www.atalasoft.com/cs/blogs/stevehawley/archive/2006/02/27/9590.aspx → mehr dazu] | [http://www.atalasoft.com/cs/blogs/stevehawley/archive/2006/02/27/9590.aspx → mehr dazu] | ||
===== [http:// | ===== [http://clean-code-developer.de/die-grade/gruener-grad/#Tell_dont_ask Tell, don't ask] ===== | ||
Eine Klasse sollte nicht von außen über ihren internen Zustand befragt werden können. Es ist besser dem Objekt mitzuteilen was es zu tun hat. Das verlagert die Logik zur Benutzung der Klasse in die Klasse selbst und der Benutzer muss sich darüber keine Gedanken mehr machen. Als Ergebnis entstehen Objekte mit Verhalten statt "dummer" Datenhaltungsobjekte. | Eine Klasse sollte nicht von außen über ihren internen Zustand befragt werden können. Es ist besser dem Objekt mitzuteilen was es zu tun hat. Das verlagert die Logik zur Benutzung der Klasse in die Klasse selbst und der Benutzer muss sich darüber keine Gedanken mehr machen. Als Ergebnis entstehen Objekte mit Verhalten statt "dummer" Datenhaltungsobjekte. | ||
[http://pragprog.com/articles/tell-dont-ask → mehr dazu] | [http://pragprog.com/articles/tell-dont-ask → mehr dazu] | ||
===== [http:// | ===== [http://clean-code-developer.de/die-grade/gruener-grad/#Law_of_Demeter Law of Demeter] ===== | ||
"Don't talk to strangers": Lange Abhängigkeitsketten zwischen den Klassen eines Projekts führen zu einer engen Kopplung im gesamten Projekt. Die erschwert Wartung, Erweiterung und Tests. Um dies zu vermeiden, sollte eine Methode nur folgende andere Methoden verwenden: | "Don't talk to strangers": Lange Abhängigkeitsketten zwischen den Klassen eines Projekts führen zu einer engen Kopplung im gesamten Projekt. Die erschwert Wartung, Erweiterung und Tests. Um dies zu vermeiden, sollte eine Methode nur folgende andere Methoden verwenden: | ||
* Methoden der eigenen Klasse | * Methoden der eigenen Klasse | ||
| Zeile 86: | Zeile 86: | ||
[http://www.aspiringcraftsman.com/tag/law-of-demeter/ → mehr dazu] | [http://www.aspiringcraftsman.com/tag/law-of-demeter/ → mehr dazu] | ||
===== [http:// | ===== [http://clean-code-developer.de/die-grade/blauer-grad/#You_Aint_Gonna_Need_It_YAGNI You ain't gonna need it (YAGNI)] ===== | ||
Programmiere nur was gebraucht wird und nicht was vielleicht irgendwann mal gebraucht werden könnte. | Programmiere nur was gebraucht wird und nicht was vielleicht irgendwann mal gebraucht werden könnte. | ||
| Zeile 92: | Zeile 92: | ||
=== Praktiken === | === Praktiken === | ||
===== [http:// | ===== [http://clean-code-developer.de/die-grade/orangener-grad/#Lesen_Lesen_Lesen Lesen] ===== | ||
Lesen ist eine der besten Übungen überhaupt und bringt neue Erfahrungen ohne den Aufwand des Schreibens. | Lesen ist eine der besten Übungen überhaupt und bringt neue Erfahrungen ohne den Aufwand des Schreibens. | ||
===== [http:// | ===== [http://clean-code-developer.de/die-grade/roter-grad/#Ein_Versionskontrollsystem_einsetzen Versionierung] ===== | ||
Systeme wie Subversion (svn) erlauben verteiltes Arbeiten mit zusätzlichem Rückgriff auf alte Versionen des Projekts. | Systeme wie Subversion (svn) erlauben verteiltes Arbeiten mit zusätzlichem Rückgriff auf alte Versionen des Projekts. | ||
===== [http:// | ===== [http://clean-code-developer.de/die-grade/roter-grad/#Die_Pfadfinderregel_beachten Scout Rule] ===== | ||
Verlasse Code immer sauberer als du ihn betrittst. Wenn man beim Lesen von Code Fehler oder Verletzungen dieser Prinzipien bemerkt, sollte man ihn gleich verbessern. | Verlasse Code immer sauberer als du ihn betrittst. Wenn man beim Lesen von Code Fehler oder Verletzungen dieser Prinzipien bemerkt, sollte man ihn gleich verbessern. | ||
===== [http:// | ===== [http://clean-code-developer.de/die-grade/roter-grad/#Root_Cause_Analysis Root Cause Analysis] ===== | ||
Nicht die Symptome sondern die Ursache bekämpfen. Wenn Probleme auftreten, immer zuerst überlegen, wo diese herkommen können. Nicht der Versuchung erliegen, nur in den zuletzt veränderten Code-Stücken zu suchen. | Nicht die Symptome sondern die Ursache bekämpfen. Wenn Probleme auftreten, immer zuerst überlegen, wo diese herkommen können. Nicht der Versuchung erliegen, nur in den zuletzt veränderten Code-Stücken zu suchen. | ||
Version vom 17. Oktober 2015, 15:13 Uhr
Clean Code Development
Hierbei handelt es sich um bewährte Prinzipien und Praktiken aus der objektorientierten Softwareentwicklung. Ein reflektiertes Verwenden dieser Richtlinien kann zu besserem und vor allem lesbarerem Quellcode führen. Diese Zusammenstellung orientiert sich an [1] und [2]. Es wurden absichtlich nicht alle Richtlinien übernommen, da sie umstritten, nicht eindeutig oder sehr schwierig anzuwenden sind.
Prinzipien
Don't repeat yourself (DRY)
Kopierter Code leistet Inkonsistenzen Vorschub und führt zu einem mehr an Fehleranfälligkeit und Arbeit. Kein Copy & Paste sondern mehrfach verwendeten Code in Funktionen und/oder Klassen auslagern.
Keep it simple, stupid (KISS)
Einfache Lösungen sind immer zu bevorzugen. Zerlege komplizierte Probleme in Teilprobleme, bis die Teilprobleme nicht weiter zerlegbar sind.
Beware of Optimizations
Optimierung bedeutet Aufwand und komplexeren Code. Solange es nicht WIRKLICH notwendig ist, sollte man darauf verzichten.
Favour Composition over Inheritance (FCoI)
Komposition ist flexibler als Ableitung. Bevor man von einer Klasse ableitet, sollte man sich daher immer zuerst fragen, ob man dasselbe Ergebnis nicht auch mit Komposition erreichen kann.
Single Responsibility Principle (SRP)
Eine Klasse sollte genau eine Aufgabe erfüllen.
Separation of Concerns (SoC)
Zerteile ein Programm in unterschiedliche Bereiche (eigentlich auf Klassenebene, aber auch auf Komponentenebene anwendbar), die jeweils eine Aufgabe haben und die sich so wenig wie möglich überlappen.
Coding Conventions
Coding Conventions sind für die Zusammenarbeit mehrerer Entwickler an einem größeren Softwareprojekt unverzichtbar. Sie erhöhen die Lesbarkeit und sorgen für Konsistenz im Quellcode. Im Softwarepraktikum wird die Einhaltung der Coding Conventions durch Resharper unterstüzt.
Interface Segregation Principle (ISP)
Interfaces sollen so klein wie möglich sein und nur beinhalten was auch wirklich benötigt wird.
Dependency Inversion Principle (DIP)
Entkopple Module über Interfaces:
- Module hoher Ebenen sollten nicht von Modulen niedriger Ebenen abhängen. Beide sollten von Abstraktionen abhängen.
- Abstraktionen sollten nicht von Details abhängen. Details sollten von Abstraktionen abhängen.
Liskov Substitution Principle (LSP)
Subtypen müssen sich so verhalten wie ihr Basistyp. Z.B. darf eine Methode, die im Basistyp keine Exception wirft, auch im Subtyp keine Exception werfen.
Allgemeiner: Ein Subtyp darf die Funktionalität eines Basistyps lediglich erweitern, aber nicht einschänken.
Information Hiding Principle
Eine Klasse sollte nur die für die Schnittstelle notwendigen Methoden und Felder öffentlich zur Verfügung stellen. Durch das Verbergen der Implementierungsdetails wird die Benutzung der Klasse von ihrer Implementierung unabhängig gemacht.
Principle of Least Astonishment
Programmteile sollten sich so verhalten, "wie man es erwartet". Funktionen sollten sich ihrem Namen entsprechend verhalten und Seiteneffekte sollten klar ersichtlich und gut dokumentiert sein.
Tell, don't ask
Eine Klasse sollte nicht von außen über ihren internen Zustand befragt werden können. Es ist besser dem Objekt mitzuteilen was es zu tun hat. Das verlagert die Logik zur Benutzung der Klasse in die Klasse selbst und der Benutzer muss sich darüber keine Gedanken mehr machen. Als Ergebnis entstehen Objekte mit Verhalten statt "dummer" Datenhaltungsobjekte.
Law of Demeter
"Don't talk to strangers": Lange Abhängigkeitsketten zwischen den Klassen eines Projekts führen zu einer engen Kopplung im gesamten Projekt. Die erschwert Wartung, Erweiterung und Tests. Um dies zu vermeiden, sollte eine Methode nur folgende andere Methoden verwenden:
- Methoden der eigenen Klasse
- Methoden der Parameter
- Methoden assozierter Klassen
- Methoden selbst erzeugter Objekte
You ain't gonna need it (YAGNI)
Programmiere nur was gebraucht wird und nicht was vielleicht irgendwann mal gebraucht werden könnte.
Praktiken
Lesen
Lesen ist eine der besten Übungen überhaupt und bringt neue Erfahrungen ohne den Aufwand des Schreibens.
Versionierung
Systeme wie Subversion (svn) erlauben verteiltes Arbeiten mit zusätzlichem Rückgriff auf alte Versionen des Projekts.
Scout Rule
Verlasse Code immer sauberer als du ihn betrittst. Wenn man beim Lesen von Code Fehler oder Verletzungen dieser Prinzipien bemerkt, sollte man ihn gleich verbessern.
Root Cause Analysis
Nicht die Symptome sondern die Ursache bekämpfen. Wenn Probleme auftreten, immer zuerst überlegen, wo diese herkommen können. Nicht der Versuchung erliegen, nur in den zuletzt veränderten Code-Stücken zu suchen.
Referenzen
- ↑ Clean Code Developer
- ↑ Robert C. Martin. Clean Code: A Handbook of Agile Software Craftsmanship. Prentice Hall PTR, Upper Saddle River, NJ, USA, 1 Edition, 2008. Bei Amazon.
