ݺߣ

ݺߣShare a Scribd company logo
Ładny Kod
Jakub Nietrzeba
Ładny Kod
Co to znaczy?

Ludzki mózg nie jest w stanie podążać za
rozgałęzieniami

Jest liniowy

Ogarnia siedem pojęć na raz – większość zdań
składa się z siedmiu wyrazów
Co to znaczy?

Brzydki kod jest pełen rozgałęzień

Jest trudny w czytaniu

Wymaga skupienia do zrozumienia

Jest mylący, zagmatwany, nasztuczkowiony

Przekracza zdolności pojmowania typowego
człowieka
Co to znaczy?
Co to znaczy?
Jak?

Odwróć ify

Jedna rzecz na raz

Nie grzeb innym w spodniach

Rąbaj metody

Nie gmatwaj

Używaj narzędzi
Odwróć ifa
Z przodu liceum
if ($request->isMethod('post')) {
if ($request->isType('ajax')) {
$data = $request->getData();
if ($data->isValid($this->rules)) {
$order = new Order($data);
return $order;
Z tyłu groza
} else {
return false;
}
} else {
return false;
}
} else {
return false;
}
Odwróć ifa
function parseOrder($request) {
if (! $request->isMethod('post')) {
return false;
}
if (! $request->isType('ajax')) {
return false;
}
$data = $request->getData();
if (! $data->isValid($this->rules)) {
return false;
}
$order = new Order($data);
return $order;
}
Jedna rzecz na raz

return $this->messages[$status];

Takie komentarze:
 // ----------- ORDER ----------------
 // calculate vat
 // 3. attach mouse to a cat

Zmienne $return, $ret, $result

Funkcje które można scharakteryzować jako te:
 Które liczą i formatują
 Które pobierają, aktualizują i zapisują
Nie grzeb obiektom w spodniach
if($order->getParams()->getParam('payment_type') == PaymentType::CARD) {
$order->getPayment()->getCard()->save();
}

Jeden -> w linii

Zamiast grzebać zapytaj:
if($order->hasCardPayment()) {
$order->saveCard();
}

Nie używaj tablic do przekazywania przetworzonych
danych!

Nie dotyczy DQL
Siecz, rżnij, rąb!

Sztywny limit długości metody (25 linii)

Sztywny limit głębokości wcięcia (2 wcięcia)
function doSomething($data) {
foreach ($data as $item) { // 1
$item->doMe(); // 2
if ($item->isYou()) {
$item->doYou(); // <---- Bąęł!
}
}
}

Sztywny limit ilości metod w klasie (larva style!)
Macarena!

Nie używaj sztuczek i mało znanych metod
 next jako podgląd pierwszego elementu tablicy

Nie używaj pełnych nazw namespace'ów
 Something/OtherThing/Library/Macarena

Jedna kropka, strzałka przyrównanie na linię

Warunki w if w jednej linijce
 Wyliczaj przed ifem
 Warunki do widoku wyliczaj w kontrolerach

Nigdy nie pisz własnego frameworka!
Używaj narzędzi

Pull request podstawowym narzędziem dbania
o przejrzystość kodu:
 Warto używać GIFów
 Brak świętych krów

Ciągła integracja i walidacja kodu:
 csfixer
 mess detector
 copy paste detector

More Related Content

Featured (20)

2024 State of Marketing Report – by Hubspot
2024 State of Marketing Report – by Hubspot2024 State of Marketing Report – by Hubspot
2024 State of Marketing Report – by Hubspot
Marius Sescu
Everything You Need To Know About ChatGPT
Everything You Need To Know About ChatGPTEverything You Need To Know About ChatGPT
Everything You Need To Know About ChatGPT
Expeed Software
Product Design Trends in 2024 | Teenage Engineerings
Product Design Trends in 2024 | Teenage EngineeringsProduct Design Trends in 2024 | Teenage Engineerings
Product Design Trends in 2024 | Teenage Engineerings
Pixeldarts
How Race, Age and Gender Shape Attitudes Towards Mental Health
How Race, Age and Gender Shape Attitudes Towards Mental HealthHow Race, Age and Gender Shape Attitudes Towards Mental Health
How Race, Age and Gender Shape Attitudes Towards Mental Health
ThinkNow
AI Trends in Creative Operations 2024 by Artwork Flow.pdf
AI Trends in Creative Operations 2024 by Artwork Flow.pdfAI Trends in Creative Operations 2024 by Artwork Flow.pdf
AI Trends in Creative Operations 2024 by Artwork Flow.pdf
marketingartwork
Skeleton Culture Code
Skeleton Culture CodeSkeleton Culture Code
Skeleton Culture Code
Skeleton Technologies
PEPSICO Presentation to CAGNY Conference Feb 2024
PEPSICO Presentation to CAGNY Conference Feb 2024PEPSICO Presentation to CAGNY Conference Feb 2024
PEPSICO Presentation to CAGNY Conference Feb 2024
Neil Kimberley
Content Methodology: A Best Practices Report (Webinar)
Content Methodology: A Best Practices Report (Webinar)Content Methodology: A Best Practices Report (Webinar)
Content Methodology: A Best Practices Report (Webinar)
contently
How to Prepare For a Successful Job Search for 2024
How to Prepare For a Successful Job Search for 2024How to Prepare For a Successful Job Search for 2024
How to Prepare For a Successful Job Search for 2024
Albert Qian
Social Media Marketing Trends 2024 // The Global Indie Insights
Social Media Marketing Trends 2024 // The Global Indie InsightsSocial Media Marketing Trends 2024 // The Global Indie Insights
Social Media Marketing Trends 2024 // The Global Indie Insights
Kurio // The Social Media Age(ncy)
Trends In Paid Search: Navigating The Digital Landscape In 2024
Trends In Paid Search: Navigating The Digital Landscape In 2024Trends In Paid Search: Navigating The Digital Landscape In 2024
Trends In Paid Search: Navigating The Digital Landscape In 2024
Search Engine Journal
5 Public speaking tips from TED - Visualized summary
5 Public speaking tips from TED - Visualized summary5 Public speaking tips from TED - Visualized summary
5 Public speaking tips from TED - Visualized summary
SpeakerHub
ChatGPT and the Future of Work - Clark Boyd
ChatGPT and the Future of Work - Clark Boyd ChatGPT and the Future of Work - Clark Boyd
ChatGPT and the Future of Work - Clark Boyd
Clark Boyd
Getting into the tech field. what next
Getting into the tech field. what next Getting into the tech field. what next
Getting into the tech field. what next
Tessa Mero
Google's Just Not That Into You: Understanding Core Updates & Search Intent
Google's Just Not That Into You: Understanding Core Updates & Search IntentGoogle's Just Not That Into You: Understanding Core Updates & Search Intent
Google's Just Not That Into You: Understanding Core Updates & Search Intent
Lily Ray
How to have difficult conversations
How to have difficult conversations How to have difficult conversations
How to have difficult conversations
Rajiv Jayarajah, MAppComm, ACC
Introduction to Data Science
Introduction to Data ScienceIntroduction to Data Science
Introduction to Data Science
Christy Abraham Joy
Time Management & Productivity - Best Practices
Time Management & Productivity -  Best PracticesTime Management & Productivity -  Best Practices
Time Management & Productivity - Best Practices
Vit Horky
The six step guide to practical project management
The six step guide to practical project managementThe six step guide to practical project management
The six step guide to practical project management
MindGenius
Beginners Guide to TikTok for Search - Rachel Pearson - We are Tilt __ Bright...
Beginners Guide to TikTok for Search - Rachel Pearson - We are Tilt __ Bright...Beginners Guide to TikTok for Search - Rachel Pearson - We are Tilt __ Bright...
Beginners Guide to TikTok for Search - Rachel Pearson - We are Tilt __ Bright...
RachelPearson36
2024 State of Marketing Report – by Hubspot
2024 State of Marketing Report – by Hubspot2024 State of Marketing Report – by Hubspot
2024 State of Marketing Report – by Hubspot
Marius Sescu
Everything You Need To Know About ChatGPT
Everything You Need To Know About ChatGPTEverything You Need To Know About ChatGPT
Everything You Need To Know About ChatGPT
Expeed Software
Product Design Trends in 2024 | Teenage Engineerings
Product Design Trends in 2024 | Teenage EngineeringsProduct Design Trends in 2024 | Teenage Engineerings
Product Design Trends in 2024 | Teenage Engineerings
Pixeldarts
How Race, Age and Gender Shape Attitudes Towards Mental Health
How Race, Age and Gender Shape Attitudes Towards Mental HealthHow Race, Age and Gender Shape Attitudes Towards Mental Health
How Race, Age and Gender Shape Attitudes Towards Mental Health
ThinkNow
AI Trends in Creative Operations 2024 by Artwork Flow.pdf
AI Trends in Creative Operations 2024 by Artwork Flow.pdfAI Trends in Creative Operations 2024 by Artwork Flow.pdf
AI Trends in Creative Operations 2024 by Artwork Flow.pdf
marketingartwork
PEPSICO Presentation to CAGNY Conference Feb 2024
PEPSICO Presentation to CAGNY Conference Feb 2024PEPSICO Presentation to CAGNY Conference Feb 2024
PEPSICO Presentation to CAGNY Conference Feb 2024
Neil Kimberley
Content Methodology: A Best Practices Report (Webinar)
Content Methodology: A Best Practices Report (Webinar)Content Methodology: A Best Practices Report (Webinar)
Content Methodology: A Best Practices Report (Webinar)
contently
How to Prepare For a Successful Job Search for 2024
How to Prepare For a Successful Job Search for 2024How to Prepare For a Successful Job Search for 2024
How to Prepare For a Successful Job Search for 2024
Albert Qian
Trends In Paid Search: Navigating The Digital Landscape In 2024
Trends In Paid Search: Navigating The Digital Landscape In 2024Trends In Paid Search: Navigating The Digital Landscape In 2024
Trends In Paid Search: Navigating The Digital Landscape In 2024
Search Engine Journal
5 Public speaking tips from TED - Visualized summary
5 Public speaking tips from TED - Visualized summary5 Public speaking tips from TED - Visualized summary
5 Public speaking tips from TED - Visualized summary
SpeakerHub
ChatGPT and the Future of Work - Clark Boyd
ChatGPT and the Future of Work - Clark Boyd ChatGPT and the Future of Work - Clark Boyd
ChatGPT and the Future of Work - Clark Boyd
Clark Boyd
Getting into the tech field. what next
Getting into the tech field. what next Getting into the tech field. what next
Getting into the tech field. what next
Tessa Mero
Google's Just Not That Into You: Understanding Core Updates & Search Intent
Google's Just Not That Into You: Understanding Core Updates & Search IntentGoogle's Just Not That Into You: Understanding Core Updates & Search Intent
Google's Just Not That Into You: Understanding Core Updates & Search Intent
Lily Ray
Time Management & Productivity - Best Practices
Time Management & Productivity -  Best PracticesTime Management & Productivity -  Best Practices
Time Management & Productivity - Best Practices
Vit Horky
The six step guide to practical project management
The six step guide to practical project managementThe six step guide to practical project management
The six step guide to practical project management
MindGenius
Beginners Guide to TikTok for Search - Rachel Pearson - We are Tilt __ Bright...
Beginners Guide to TikTok for Search - Rachel Pearson - We are Tilt __ Bright...Beginners Guide to TikTok for Search - Rachel Pearson - We are Tilt __ Bright...
Beginners Guide to TikTok for Search - Rachel Pearson - We are Tilt __ Bright...
RachelPearson36

Ładny Kod

  • 3. Co to znaczy?  Ludzki mózg nie jest w stanie podążać za rozgałęzieniami  Jest liniowy  Ogarnia siedem pojęć na raz – większość zdań składa się z siedmiu wyrazów
  • 4. Co to znaczy?  Brzydki kod jest pełen rozgałęzień  Jest trudny w czytaniu  Wymaga skupienia do zrozumienia  Jest mylący, zagmatwany, nasztuczkowiony  Przekracza zdolności pojmowania typowego człowieka
  • 7. Jak?  Odwróć ify  Jedna rzecz na raz  Nie grzeb innym w spodniach  Rąbaj metody  Nie gmatwaj  Używaj narzędzi
  • 8. Odwróć ifa Z przodu liceum if ($request->isMethod('post')) { if ($request->isType('ajax')) { $data = $request->getData(); if ($data->isValid($this->rules)) { $order = new Order($data); return $order; Z tyłu groza } else { return false; } } else { return false; } } else { return false; }
  • 9. Odwróć ifa function parseOrder($request) { if (! $request->isMethod('post')) { return false; } if (! $request->isType('ajax')) { return false; } $data = $request->getData(); if (! $data->isValid($this->rules)) { return false; } $order = new Order($data); return $order; }
  • 10. Jedna rzecz na raz  return $this->messages[$status];  Takie komentarze:  // ----------- ORDER ----------------  // calculate vat  // 3. attach mouse to a cat  Zmienne $return, $ret, $result  Funkcje które można scharakteryzować jako te:  Które liczą i formatują  Które pobierają, aktualizują i zapisują
  • 11. Nie grzeb obiektom w spodniach if($order->getParams()->getParam('payment_type') == PaymentType::CARD) { $order->getPayment()->getCard()->save(); }  Jeden -> w linii  Zamiast grzebać zapytaj: if($order->hasCardPayment()) { $order->saveCard(); }  Nie używaj tablic do przekazywania przetworzonych danych!  Nie dotyczy DQL
  • 12. Siecz, rżnij, rąb!  Sztywny limit długości metody (25 linii)  Sztywny limit głębokości wcięcia (2 wcięcia) function doSomething($data) { foreach ($data as $item) { // 1 $item->doMe(); // 2 if ($item->isYou()) { $item->doYou(); // <---- Bąęł! } } }  Sztywny limit ilości metod w klasie (larva style!)
  • 13. Macarena!  Nie używaj sztuczek i mało znanych metod  next jako podgląd pierwszego elementu tablicy  Nie używaj pełnych nazw namespace'ów  Something/OtherThing/Library/Macarena  Jedna kropka, strzałka przyrównanie na linię  Warunki w if w jednej linijce  Wyliczaj przed ifem  Warunki do widoku wyliczaj w kontrolerach  Nigdy nie pisz własnego frameworka!
  • 14. Używaj narzędzi  Pull request podstawowym narzędziem dbania o przejrzystość kodu:  Warto używać GIFów  Brak świętych krów  Ciągła integracja i walidacja kodu:  csfixer  mess detector  copy paste detector