|
1 | 1 | # 🎩 «Денди-код» |
2 | 2 |
|
3 | | -> Кулинарная книга (cookbook) по выразимому, аккуратному коду: короткие рецепты с примерами «до/после» и понятными шагами внедрения. |
| 3 | +> Руководство о том, как писать код с аккуратностью, уважением к читателю и стилем — даже если вы новичок. |
4 | 4 |
|
5 | 5 |
|
6 | 6 | ## 📘 О книге |
7 | 7 |
|
8 | | -Краткая и практичная книга о том, как писать понятный и аккуратный код с примерами на PHP. Приёмы универсальны и легко переносятся на любой объектно‑ориентированный язык. Вместо теории — конкретные «рецепты»: один приём — одна проблема — один понятный результат. |
9 | | - |
10 | | -- Фокус на визуальной читаемости и «голосе» кода |
11 | | -- Короткие главы, минимум «воды» и спорных догм |
12 | | -- Примеры «плохо/хорошо», которые можно повторить за 10–15 минут |
13 | | - |
14 | | - |
15 | | -## 👥 Кому подойдёт |
16 | | - |
17 | | -- Начинающим — чтобы быстро выровнять стиль и уверенно читать чужой код |
18 | | -- Опытным — как набор проверенных практик и согласованный язык команды |
19 | | -- Тимлидам — как база для онбординга, код‑ревью и внутренних соглашений |
20 | | - |
21 | | - |
22 | | -## 🧑🍳 Как пользоваться |
23 | | - |
24 | | -### В одиночку |
25 | | -- Откройте любую главу из `/content` → примените один рецепт к своему проекту |
26 | | -- Начните с форматирования и имён, затем двигайтесь к условиям/исключениям и тестам |
27 | | -- Фиксируйте прогресс чек‑листом pull‑реквестов: «минимум один рецепт на PR» |
28 | | - |
29 | | -### В команде |
30 | | -- Включите главы как основу для внутренних правил (style guide) и ревью‑чек‑листов |
31 | | -- Автоматизируйте «механику» (линтеры, автоформатирование), обсуждайте «смысл» в ревью |
32 | | -- Используйте главы для онбординга: по 1–2 рецепта на спринт, с короткими демо |
33 | | - |
34 | | - |
35 | | -## 📚 Содержание (выборочно) |
36 | | - |
37 | | -- [Форматирование](./content/005-code-style.md) |
38 | | -- [Код должен дышать](./content/006-code-breath.md) |
39 | | -- [Именование](./content/007-naming.md) |
40 | | -- [Магические значения](./content/008-magic-value.md) |
41 | | -- [Размер имеет значение](./content/009-size.md) |
42 | | -- [Без лишних движений](./content/010-no-nonsense.md) |
43 | | -- [Ранний выход](./content/011-early-exit.md) |
44 | | -- [Управляющие конструкции](./content/012-conditions.md) |
45 | | -- [Аргументы](./content/013-arguments.md) |
46 | | -- [Обработка ошибок](./content/014-exceptions.md) |
47 | | -- [Комментарии](./content/015-comments.md) |
48 | | -- [Не бойся удалять код](./content/016-remove.md) |
49 | | -- [Тесты](./content/017-tests.md) |
50 | | -- [Играй по правилам (фреймворки)](./content/018-frameworks.md) |
51 | | -- [Не отказывайтесь от будущего (обновления)](./content/019-upgrade.md) |
52 | | -- [Второй пилот — не капитан (LLM)](./content/020-copilot.md) |
| 8 | +Краткая и практичная книга о том, как писать понятный и аккуратный код с примерами на PHP. Книга не уходит в теоретические дебри, не спорит о вкусе и не переоценивает значение философии чистоты. Она фокусируется на самом первом шаге к хорошему коду — **его визуальной читаемости**. Здесь вы найдёте рекомендации, которые можно и нужно применять сразу на практике. |
53 | 9 |
|
54 | 10 |
|
55 | 11 | ## 🗂 Структура репозитория |
|
62 | 18 |
|
63 | 19 | ## ❓ FAQ |
64 | 20 |
|
65 | | -**Когда будет готова книга?** |
66 | | -Я пока не уверен в точных сроках. Нажмите на «колокольчик» рядом со ⭐️, чтобы получать уведомления. |
67 | | - |
68 | | -**Я не пишу на PHP — будет ли книга полезна?** |
69 | | -Да. Принципы универсальны, примеры легко читаются и переносятся в любой ООП‑язык. |
| 21 | +**Когда будет готова книга?** |
| 22 | +Я пока не уверен в точных сроках. Просто нажмите на колокольчик рядом с кнопкой звезды, чтобы получать уведомления о новых изменениях! |
70 | 23 |
|
71 | | -**Можно ли использовать книгу для команды?** |
72 | | -Да. Это cookbook: берёте рецепт → добавляете в чек‑лист ревью → автоматизируете там, где возможно. |
| 24 | +**Я не пишу на PHP — будет ли книга полезна для меня?** |
| 25 | +Определённо! Хотя примеры приведены на PHP, все советы универсальны и легко применимы к любому объектно-ориентированному языку программирования. |
73 | 26 |
|
74 | | -**Как предложить идею или правку?** |
75 | | -Создайте issue/PR или напишите автору в [Telegram](https://t.me/tabuna). |
| 27 | +**Могу ли я предложить свои идеи для книги?** |
| 28 | +Конечно! Если у вас есть идеи или предложения, буду рады их услышать. Пожалуйста, напишите мне в [Telegram](https://t.me/tabuna). |
76 | 29 |
|
77 | | -**Будет ли электронная версия?** |
78 | | -Да, PDF и, возможно, другие форматы. |
| 30 | +**Будет ли книга доступна в электронном формате?** |
| 31 | +Да, книга будет доступна в формате PDF и, возможно, других форматах. |
79 | 32 |
|
80 | 33 |
|
81 | 34 | ## ✨ Поддержите проект |
82 | 35 |
|
83 | | -Если вам близка идея вдумчивого и человечного программирования — поставьте ⭐️ репозиторию. |
| 36 | +Если вам близка идея вдумчивого и человечного программирования — поставьте ⭐️ репозиторию. |
84 | 37 | Это поможет книге найти своего читателя и ускорит её выпуск. |
85 | 38 |
|
86 | 39 | Если хотите поддержать проект финансово — это можно [сделать прямо сейчас](https://laravel.su/donate). Спасибо! 💖 |
|
89 | 42 |
|
90 | 43 | Я буду рад, если вы поможете рассказать о книге. |
91 | 44 | Поделитесь ею с друзьями, коллегами или в любимом чате — пусть о ней узнают те, кому это может пригодиться. |
92 | | -Для меня это не менее ценно, чем ⭐️ или донат. |
| 45 | +Для меня это не менее ценно, чем ⭐️ или донат. |
0 commit comments