525просмотров
17 февраля 2023 г.
Score: 578
💬 Code as a documentation
Утилитарный нейминг handleChangeGeoLocationModal— код превращается в набор блоков, делающих что-то. Писать легко, переспользовать тоже — понимать сложно. Особенно сложно понять, когда кода много, прошло много времени или вы новый человек на проекте. Пример на скрине 1 ниже, под постом. Если добавить промежуточные функции и переменные — любой код с доп. неймингом — получится “code as documentation”. Пример на скрине 2 ниже, под постом. С удовольствием возвращаюсь в проекты с таким documentation-like кодом, куда прихожу что-то сделать через X месяцев [порой лет] — легко понять, что и почему происходит. Почти, как прочесть небольшой рассказ. Утилитарный стиль быстрее написать. В шорт-терм так делать окей — надо захакатонить, решить задачу наколнеке, прочие частности. Если писать так в long-term, то становится дорого:
— передавать другим проект — сложнее понять, что и почему происходит, объяснить другим. Другие разрабы не угадывают из написанного, почему сделано так, а не иначе. — возвращаться самому через время — та же проблема, но чуть лучше. Своя голова узнает хоть что-то. Понял, что часто про это писал в code review за последние N лет. Вынес в заметку, чтобы переиспользовать 🙂