Что делает код хорошим?
Читаемость и стиль: код, который могут читать люди, а не только компьютеры
- объяснить, почему «работает» — это ещё не всё,
- давать вещам понятные имена,
- разбивать большую задачу на маленькие аккуратные части,
- держать структуру опрятной и понятной.
1. Код читают люди
Компьютеру всё равно, аккуратный ли у тебя код. Он выполнит любые правильные шаги. Но код читают и люди — чтобы исправить баги, добавить новые части или понять, как он работает. Чаще всего код читают гораздо больше раз, чем пишут!
Поэтому «хороший код» — это две вещи: он работает и его легко читать и менять. Если код работает, но никто не может его понять, потом его тяжело чинить. Писать понятно — это забота о следующем читателе.
2. Понятные имена
У каждой коробки (места для значения) и у каждого помощника должно быть имя, которое говорит, что это. Хорошее имя объясняет свою работу, чтобы не приходилось гадать.
| Непонятное имя | Понятное имя |
|---|---|
| x | score (счёт) |
| n | numberOfPlayers (числоИгроков) |
| doStuff | addPoints (добавитьОчки) |
| a2 | playerName (имяИгрока) |
Думай об именах как о наклейках на коробках. Коробку с надписью «счёт» легко найти. А коробку «x» приходится открывать, только чтобы вспомнить, что внутри.