TL;DR: A comment on Clean Code Cookbook in Japanese

This is the opinion on Clean Code Book by Naoki Hayashida translated by Google.

Original in Japanese:

My collection of books has increased dramatically over the last month and this month, so I have quite a lot of unread books ...

I have finished reading one of the above, the Clean Code Cookbook, so I would like to share my thoughts on it.

Not for beginners This book is not the kind of book that tells you how to write clean code by following recipes. It is not a "collection of recipes that you can follow to write clean, working code," but rather a "collection of recipes that will help you understand the principles, carefully consider whether they should be applied, and then improve your own code."

Therefore, this book is intended for people who have basic knowledge ofobject-oriented programming and have experience programming systems of a certain size.

Also, the sample codes are written in multiple programming languages , so it may be difficult for people who cannot read other languages ​​at all. Moreover, most of the sample codes do not state which language they are written in.

Of course, there are many small code examples that are easy to understand even if you have never used the language itself, so if you have some experience or knowledge of multiple programming languages, you don't have to worry . However, if you are only at the level of being able to write one programming language at best , it is quite possible that you will not be able to read all the sample code.

It is important to read the first two chapters carefully. Like other cookbooks, the majority of this book is a collection of recipes. However, it does not simply list patterns; the first two chapters are introductions and principles.

This principle is quite important, and the whole book is based on the principles up to Chapter 2. Therefore, if you look at this book as a collection of patterns without reading up to this chapter, you will miss the important viewpoints of this book, so I recommend that you hold off on reading the recipes that interest you first and read up to Chapter 2.

Sometimes I think, "Hmm, this is..." Personally, there were some parts that made me wonder, "What's this about...?" For example, "I understand it from an implementation point of view, but is it essential as an expression of the business domain ?" I think it's fine if the logic remains within a certain object because the external behavior doesn't change, but there are some recipes that I'm a little concerned about even if they are internal expressions.

Also, in certain languages, what are called anti-patterns in recipes are considered to be so-called common code patterns. I think that you can't just apply these things because they're in the recipe.

However, most of the recipes are ones that you will think "this is it," so I think it's important for you to think for yourself, "I will try this recipe" or "I won't try this recipe."

It's extensive and voluminous, so it's probably a good idea to re-read it several times. It's a lengthy book, and contains content in a variety of contexts, so it's not the kind of book you can learn by reading it once, nor is it the kind of book you can learn by copying out example code.

On the other hand, I think the easiest way to use it is to look back at it when you notice in your code that "Oh, this is similar to a problem with a recipe in the Clean Code Cookbook." I also think it would be good to use it as a basis for creating a common understanding within a development team, such as "Do you want to apply the recipe in the Clean Code Cookbook?"

My personal favorite recipe This is a recipe that I personally liked.

Recipe 3.6　EliminatingDTOs This recipe advises against using (Local) DTOs used in specific frameworks , etc.

If you are using a specific framework , this may be a recipe that you would be strongly opposed to, but if you look at it neutrally, it is true that there are disadvantages to this, such as it makes it easy to mass-produce boilerplate code and makes it easy to create objects equivalent to an anemic domain model .

Personally, I have rarely come across critical articles about DTOs on the web, so I found it interesting to see it described as a recipe.

Of course, I think this pattern has advantages such as "loose couplingbetween layers" and "no need to expose unnecessary domain logic to the presentation layer." However, this article makes me think that we should not just think that it's okay to use DTOs without thinking.

After reading this recipe, if you are thinking of usingDTO , I think it might be interesting to think, "Is there a way to obtain the same benefits as DTO ?"

Recipe 16.4 Avoiding Overgeneralizations Sometimes abstractions are made that say commonality is justice, but the logic behind this recipe is that we should avoid commonalizing things that happen to match at the time.

This recipe, like the others, is written quite briefly, but I think it is a pretty important recipe, as standardization is always thought to be a principle of programming.

Summary

I think the Clean Code Cookbook is a book that will be useful for people who are actually writing code for medium-sized or larger systems to look back on how they write code and get closer to clean code. I think it would be a good idea to read it as an individual or as a team and aim for clean code.

TL;DR: You can read Clean Code cookbok in Serbian

Često softverski inženjeri i arhitekte rade sa velikim, kompleksnim bazama koda koje treba da skaliraju i održavaju. U ovom priručniku, autor Maksimilijano Kontijeri vas vodi dalje od koncepta čistog koda pokazujući vam kako da identifikujete mogućnosti za poboljšanje i njihov uticaj na produkcijski kod. Kada je reč o pouzdanosti i evoluciji sistema, ove tehnike pružaju prednosti koje se isplate vremenom.

Koristeći stvarne primere u JavaScript-u, PHP-u, Javi, Pythonu i mnogim drugim programskim jezicima, ovaj priručnik pruža proverene recepte koji vam pomažu da skalirate i održavate velike sisteme. Svaki odeljak pokriva osnovne koncepte uključujući čitljivost, spregu, testabilnost i proširivost, kao i mirise koda - simptome problema koji zahtevaju posebnu pažnju - i recepte za rešavanje istih.

Buy it

TL;DR: You can read Clean Code cookbok in Russian

Для инженеров-разработчиков и архитекторов, имеющих дело с большим объемом сложного кода, важно эффективно его масштабировать и обслуживать. Автор Максимилиано Контьери выходит за рамки концепции чистого кода, показывая, как искать возможности улучшения и оценивать их влияние на код готового программного продукта. Когда речь идет о надежности и развитии, эти методы обеспечивают преимущества, которые со временем окупаются. Проверенные рецепты на JavaScript, PHP, Python, Java и других языках программирования помогут масштабировать и поддерживать большие системы. В каждом разделе рассматриваются такие фундаментальные понятия, как читаемость кода, связанность, тестируемость, безопасность и расширяемость, а также запахи кода и соответствующие рецепты их устранения.

Buy it

Buy it

Review

TL;DR: Read these concise articles to quickly learn and apply clean code principles with clear, precise examples!

TL;DR: You can read Clean Code Cookbook in many different languages

Clean Code Cookbook is available in these languages:

English

Bulgarian

Chinese

German

Polish

Indian Re print

Korean

Russian

Serbian

Online

You can read the book online at the O'Reilly learning platform:

And also read the shortcuts:

TL;DR: You can read Clean Code cookbok in Bulgarian

Софтуерните инженери и архитекти, работещи с големи и сложни кодови бази, трябва да могат да ги поддържат и разширяват ефективно. Книгата с рецепти на Максимилиано Контиери ви отвежда отвъд концепцията за чистия код, като ви показва как да идентифицирате възможностите за извършване на подобрения и да оценявате потенциалното им въздействие върху продуктовия код. Когато става дума за надеждност и еволюция на системата, тези техники носят ползи, които се отплащат във времето.

В книгата ще намерите доказани рецепти за реални ситуации на JavaScript, PHP, Python, Java и много други езици за програмиране, които ще ви помогнат при поддръжката и мащабирането на големи системи. Включени са фундаментални концепции за чист код, сред които четимост, функционална обвързаност, тестове, безопасност, разширяемост и миришещ код, заедно със съответните рецепти.

Представените в книгата рецепти за рефакторинг и проблемите, които се решават с тях, са с нарастваща сложност.

От тази книга: • ще научите за ползите от чистия код и ще разберете как да идентифицирате възможностите за подобрение; • ще се запознаете с техники за рефакторинг стъпка по стъпка; • ще разберете теорията зад чистия код; • ще видите реални примери на различни ези­ци за програмиране; • ще получите изчерпателен каталог с миришещи кодове, заедно с обсега на въздействието им и възможните решения; • ще започнете да пишете код по същество, отдавайки превес на четимостта.

„Изключително съдържателна книга с добре обяснена теория и много практически примери. Препоръчителна за всички, опит­ващи се да създават качествен софтуер.“ – Даниел Мока, софтуерен разработчик в Moka IT

„Макси е учен практик, чийто богат опит в софтуерната разработка е синтезиран по великолепен начин в книгата.“ – Алекс Бунарджич, софтуерен разработчик и инструктор

Максимилиано Контиери е в софтуерната индустрия повече от 25 години, като в същото време чете лекции по компютърни науки в Университета на Буенос Айрес. Пише статии за чист код, рефакторинг и миришещ код в популярни платформи. Максимилиано изповядва декларативните и поведенчески парадигми в програмирането, залагайки на основите на софтуера, с цел създаването на елегантни, мащабируеми и стабилни решения.

TL;DR: You can read Clean Code cookbok in Polish

Funkcjonalność oprogramowania nieustannie się poszerza, a nowoczesny kod jest coraz częściej generowany przez narzędzia oparte na sztucznej inteligencji. W tych warunkach czystość kodu staje się niezwykle ważna. Niezależnie od tego, czy pracujesz na oprogramowaniu zastrzeżonym, czy otwartym, czysty kod jest najlepszym sposobem na to, aby zachować świeżość projektów i ich gotowość do rozwoju.

TL;DR: New recipes every two weeks

To complement my Clean Code Cookbook, you can now explore new shortcuts on the O'Reilly platform.

These concise articles focus on specific coding techniques.

The first five shortcuts are available for you to read now.

There will be the new ones added every two weeks.

TL;DR: How to navigate, test and use the book's source code

The sources were always available but there were no pointers from this site.

I am adding it explitly.

The code is live. I keep improving it with your comments and erratas, changing formatting and more.

You can find the source code here:

TL;DR: German version is available

Beschreibung

Entwickler, Software Engineers und -Architektinnen, die mit einer umfangreichen Codebasis arbeiten, müssen ihren Code effektiv pflegen und erweitern. In diesem Kochbuch vermittelt Maximiliano Contieri das Konzept des Clean Code, geht aber noch einen Schritt weiter. Er zeigt, wie Sie Verbesserungspotenziale identifizieren und deren Auswirkungen auf den Produktionscode beurteilen. Mithilfe der vorgestellten Techniken kann die Zuverlässigkeit und Entwicklungsfähigkeit der Systeme deutlich verbessert werden.Anhand von Beispielen in JavaScript, PHP, Python, Java und vielen anderen Programmiersprachen bietet dieses Kochbuch bewährte Rezepte, die Sie bei der Erweiterung und Wartung größerer Systeme unterstützen. Contieri beschreibt grundlegende Konzepte wie Lesbarkeit, Kopplung, Testbarkeit, Sicherheit und Erweiterbarkeit sowie Code Smells und Rezepte zu deren Beseitigung.Im Verlauf dieses Buches werden die Refactoring-Rezepte und die Probleme, die sie lösen, immer komplexer.Sie werden:• die Vorteile von Clean Code verstehen und lernen, wie Sie Verbesserungsmöglichkeiten identifizieren• Refactoring-Techniken Schritt für Schritt erlernen• sich mit der Theorie hinter Clean Code vertraut machen• Beispiele aus der Praxis in verschiedenen modernen Programmiersprachen untersuchen• in einem Katalog mit Code Smells stöbern, deren Auswirkungen und Lösungsansätze zu ihrer Beseitigung nachvollziehen• Code schreiben, der auf den Punkt kommt, leichter zu lesen und zu verstehen ist

Thank you very much Jens Olaf Kock for your amazing help!

TL;DR: This is my talk at Tech Excellence on combining Artificial Intelligence and Clean Code Recipes

Summary

How can you leverage ChatGPT, Gemini, Copilot, and other assistants to write clean code? What instructions should you provide them? How do you configure them to assist you?

Code assistants were trained on datasets that were not so well curated. You often ask them for solutions that meet requirements but do not reflect good designs. However, with some instructions, you can indicate how we want them to assist you. This way, their solutions will comply with good development practices and be customized according to your rules.

You will see concrete examples and tips to make the most of these magnificent tools by combining your creativity with all available knowledge. After watching the talk, you can explain your rules for immediate assistance in your studies, work, and more. This will enhance your professional career, preparing you for the future demands of the job market.

Most code examples and recipes are from the book, it is an excellent companion and update by applying the AI to the recipes.

Thank you, Guilherme!

TL;DR: Find the Quizzes in the O'Reilly Learning Platform

I am thrilled to announce that Clean Code Cookbook is now available in an interactive format, enriched with self-evaluation quizzes!

This new offering is designed to elevate your learning experience and deepen your understanding of the material like never before.

Why Interactive?

Traditional learning methods are evolving rapidly to meet the demands of modern readers.

Passive reading can only take you so far.

That's why I've transformed my book into an interactive journey, where you can actively engage with the content.

Dive into the material like never before. With interactive features embedded throughout the book, you'll fully immerse yourself in the subject matter.

Test your knowledge and track your progress with our self-evaluation quizzes. These quizzes are strategically placed within the book to reinforce key concepts and help you gauge your understanding.

Receive instant feedback on your quiz responses. Whether you aced it or stumbled upon a tricky question, the interactive format ensures that you receive immediate insights to guide your learning journey.

How to Access:

The interactive book is available in digital format on the O'Reilly Platform.

You can sign up for a free 30-day free trial on more than 30.000 books.

Happy learning!

You are very welcomed to write your own opinion on the book here

All opinions help with the book distribution.

See Lukas' full article below

Direct Link

See you there!

I am consistently producing new articles, (maybe a second part).

These articles are published on my blog to gather feedback, suggestions, and corrections.

Feel free to subscribe to receive notifications about new articles!

TL:DR; You can read "Clean Code Cookbook" in google play

Visit the Google Play Store