Rafał Wesołowski CLEAN CODE

Größe: px

Ab Seite anzeigen:

Download "Rafał Wesołowski CLEAN CODE"

Max Eberhardt
vor 8 Jahren
Abrufe

1 Rafał Wesołowski CLEAN CODE

2 Rafał Wesołowski Beruf: - ecommerce Software Engineer bei der Internetagentur NEXUS Netsoft GmbH - Ausbilder - PHP und JS Experte - Agile Design Pattern Enthusiast - Innovations Fan Privat: - Vater und Ehemann - Kampfsportler - Mehrfacher Polen-Meister im Ju-Jitsu

3 1 Der Fehler-Eisberg 2 1. Shop offline 3 2. Checkout / Artikel zum Warenkorb hinzufügen 4 3. Fehler bei Slider, Direktbestellung, Bannermodul usw Modul / Plugin funktioniert nicht wie gewünscht 5. PHP Warning / Notice

4 Applikation :Theorie / Praxis Quelle:

5 Applikation :Theorie / Praxis Quelle:

6 Code: Lesen / Schreiben Wie viele Stunden pro Tag?

7 Keep It Simple Stupid

8 space pen

9 128,89 $ space pen

10 space pen und Bleistift 128,89 $ 0,24

11 /index.php?lang=1=9%3b(function()%7bqxss%7d)%3b%2f%2f Cross-Site-Scripting

12 Cross-Site-Scripting /index.php?lang=1=9%3b(function()%7bqxss%7d)%3b%2f%2f index.php:2 $_GET['lang'] = (int)$_get['lang'];

13 Strukturiertes entwickeln Beispiel: PayPal-Zahlungsart

14 PayPal-Zahlungsart #1: Warenkorb #2: Zahlungsart #3: Zusammenfassung #4: PayPal #5: Danke-Seite

15 Warenkorb Zahlungsart Zusammenfassung Pay-Pal Danke-Seite PayPal-Zahlungsart

16 PayPal-Zahlungsart Warenkorb Zahlungsart Zusammenfassung Pay-Pal Danke-Seite Warenkorb Zahlungsart Zusammenfassung Pay-Pal Abbrechen-Button Zahlungsart Warenkorb Zahlungsart Zusammenfassung Pay-Pal Fehler in PayPal Zahlungsart Warenkorb Zahlungsart Zusammenfassung Pay-Pal zurück Button Zusammenfassung Warenkorb Zahlungsart Zusammenfassung Pay-Pal zurück zum Shop Warenkorbänderung

17 PayPal-Zahlungsart Warenkorb Zahlungsart Zusammenfassung Pay-Pal Danke-Seite Warenkorb Zahlungsart Zusammenfassung Pay-Pal Abbrechen-Button Zahlungsart Warenkorb Zahlungsart Zusammenfassung Pay-Pal Fehler in PayPal Zahlungsart Warenkorb Zahlungsart Zusammenfassung Pay-Pal zurück Button Zusammenfassung Warenkorb Zahlungsart Zusammenfassung Pay-Pal zurück zum Shop Warenkorbänderung Warenkorb Zahlungsart Zusammenfassung Pay-Pal Status: pending Danke-Seite Warenkorb Zahlungsart Zusammenfassung Pay-Pal bezahlt Keine Danke-Seite

18 Namenskonvention Der Clean-Code

19 Schlechte Bezeichnung <?php class Info { public function get() { $c = $this->getcontent(); $di = []; foreach ($c as $i) { if ($i->modus == 2) { //ist Rabatt? $di[] = $i; } } } } return $di;

20 Gute Bezeichnung <?php class BasketContent { public function getdiscountproductsfrombasket() { $basketitems = $this->getbasketcontent(); $discountitems = []; foreach ($basketitems as $item) { if ($item->isvoucher()) { $discountitems[] = $item; } } } } return $discountitems;

21 Codestruktur Klassen/Methoden Klassen Methoden nur eine Aufgabe erfüllen wenige Methoden wenige Abhängigkeiten nur eine Aufgabe erfüllen wenige Arguments wenige Verschachtelungen

22 Schlechte Codestruktur

23 Gute Codestruktur <?php class SaveOrder { public function construct( Order $order ) { //... } public function save() { //... } private function payment() {} private function billingaddress() {} private function shippingaddress() {} private function orderarticles() {} private function sendmail() {} } //...

24 Codestruktur <?php class Foo { public $one; private $two; private $three; Class Public Eigenschaften Private / Protected Eigenschaften construct Public Methoden Private / Protected Methoden public function construct() {} public function funone() {} public function funtwo() {} private function funthree() {} } private function funfour() {}

25 Kommentare

26 /** * Prüft ob die existiert * Max Müller <max@müller.de> string $ - Adresse boolean */ protected function check exists( $ ); Unnötige Kommentare

27 Unnötige Kommentare /** * Funktion erstellt eigene Thumbs * * $index kann eine Nummer vom Bild sein (see elseif (is_numeric($index))) * oder kann eine URL sein: (" * oder "startslider/img/img.jpg" * * Wichtig! Wenn $index eine URL ist, bitte zwei Ordner erstellen (CHMOD 777): * - /out/master/{deinordner}/{deinordner2}/ (<- Dein Master Bilder z.b /out/master/startslider/img/) * - /out/generated/{deinordner}/{deinordner2}/ (<- Thumbs generieren z.b /out/generated/startslider/img/) * int string $index Bildnummer oder Bild-Url int $width Breite int $height Höhe string $configsize Größe aus dem Admin Backend (Themes->Einstell.->Bilder). * string */ public function getcustomthumbnailurl($index = 1, $width = null, $height = null, $configsize = null)

28 Richtig kommentieren Klassen-Kommentare hinzufügen Methoden haben als Kommentare Methoden Kommentare nur verwenden wenn dies nötig ist! Inline Kommentare vermeiden

29 Clean Code Code Review Verwendung des PSR-Standards CodeSniffer / Mess Detector / Copy Paste Detector Boy Scout Rule Unit-Test / Integration-Test

30 Tools Scrutinizer SensioLabsInsight Code Climate codacy

31 Clean Code ist ein Weg, kein Ziel

32 Rafał Wesołowski DANKESCHÖN

Ähnliche Dokumente

Einführung in Javadoc

Einführung in Javadoc Johannes Rinn http://java.sun.com/j2se/javadoc Was ist Javadoc? Javadoc ist ein Werkzeug, dass eine standardisierte Dokumentation für die Programmiersprache Java unterstützt. Vorteil: