Читаемый код или программирование как искусство
Сейчас я читаю книгу «Читаемый код или программирование как искусство». В ней куча годных мыслей и примеров, которыми хочется поделиться. Но в одну заметку всё не уместится, поэтому я решил пересказывать книгу по несколько глав за раз. В этой заметке 1–4 главы.
Глава 1: код должен быть простым для понимания
Код чаще читают чем пишут. Чем быстрее человек понимает незнакомый код, тем он проще. В понятном коде легко найти баги и исправить их, не сломав при этом программу.
Короче — не всегда лучше для понимания:
Поэтому стремиться к компактности хорошо, но стремиться к высокой читаемости лучше.
Глава 2: подбирайте точные имена для переменных, функций и классов
Например, в функции GetPage слово get неточное. Оно не объясняет, берётся ли страница из кэша или из сети. Названия FetchPage или DownloadPage лучше объяснят, что происходит.
В примере ниже из тела функции и так понятно, что retval — возвращаемое значение.
Однако неясно, что оно в себе содержит, из-за этого просто пропустить ошибку:
Вместо абстрактных имён используйте конкретные, заточенные под ситуацию. Такие имена сами объясняют, для чего нужна переменная или функция. А конкретика помогает избежать двусмысленности.
Префиксы и суффиксы уточняют смысл. Например, измеряем скорость загрузки веб-страницы:
Если вы знакомы с Джаваскриптом, то заметили ошибку — getTime возвращает результат в миллисекундах. Поэтому код работает неправильно. Если добавить суффикс _ ms, то ошибку будет заметно:
Длина имени зависит от размера области видимости. Если переменная лежит внутри функции из 3 строк, то короткое имя ей подойдёт. Но чем больше область видимости, тем точнее должно быть имя. Например, days_since_last_update будет лучше, чем просто days.
Сокращения в именах вызывают вопросы. Для расшифровки сокращения может не хватать знаний. Кроме того сокращение проще всего истолковать неправильно. Поэтому BEManager — плохое имя, BackEndManager — лучше.
Если слово не дополняет смысл названия, его лучше выбросить. Например, convert_to_string можно заменить на to_string.
Правило для выбора имени: «Если новый член команды не может понять смысла функции или переменной по её названию, это плохое имя».
Глава 3: избегайте двусмысленных названий
Тестируйте названия на неверные интерпретации. Спросите себя, что ещё может подразумеваться под этим именем. Например, функция filter непонятная: она выбирает или значения, которые подходят под условие, или наоборот. А вот названия select или exclude сразу говорят, какие результаты мы получим.
Для булевых переменных используйте префиксы is, has, can, should Актуально и для функций, которые возвращают булево значение.
Глава 4: красивый код быстрее считывается
Избавляйтесь от непоследовательности. Используйте вспомогательные функции. Например, функция и тест для неё:
Две строки не влезают и перескакивают на следующие, читатель собьётся. Этого можно избежать с помощью вспомогательной функции:
При объявлении переменных, разбивайте их на смысловые блоки:
Сам код тоже можно разбивать на «параграфы». Если функция состоит из нескольких шагов, выделите эти шаги в коде пустыми строками между ними.
Что дальше?
На следующей неделе поговорим о главах 5–7. Расскажу, как:
Читаемый код, или Программирование как искусство PDF
Те, кто искали эту книгу – читают
Эта и ещё 2 книги за 299 ₽
Любому программисту доводилось видеть код, который настолько неаккуратен и так пестрит ошибками, что от его чтения начинает болеть голова. За пять лет авторы этой книги проанализировали сотни примеров «плохого» кода (в основном – собственного), пытаясь определить, чем плох тот или иной код и как его можно улучшить. К какому выводу они пришли? Необходимо писать такой код, который читатель сможет понять максимально быстро, причем, даже если этот читатель – сам создатель этого кода.
В данной книге рассматриваются базовые принципы и практические методы, которые можно применять всякий раз при написании кода. В каждой главе на примере несложных образцов кода, написанного на разных языках программирования, изучается отдельный аспект создания кода и демонстрируется, как сделать код простым для понимания.
Отзывы 1
Хорошая книга, рекомендую всем программистам
С первых строк даются простые советы, позволяющие качественно улучшить свой код. Помню, на заре моего интереса к программированию листал похожие книги, но не понимал всю важность заключённой в них информации. Сейчас, имея некоторый опыт программирования могу сказать, что к словам авторов следует прислушиваться как можно раньше.
Особенно будет полезно профессиональным программистам, работающим в команде, либо участвующим в разработке долгосрочных проектов с постоянно меняющимися требованиями. Сэкономите время себе и люди поддерживающие код будут меньше материться.
Читаемый код, или Программирование как искусство
Описание книги
Любому программисту доводилось видеть код, который настолько неаккуратен и так пестрит ошибками, что от его чтения начинает болеть голова. За пять лет авторы этой книги проанализировали сотни примеров «плохого» кода (в основном – собственного), пытаясь определить, чем плох тот или иной код и как его можно улучшить. К какому выводу они пришли? Необходимо писать такой код, который читатель сможет понять максимально быстро, причем, даже если этот читатель – сам создатель этого кода.В данной книге р.
Любому программисту доводилось видеть код, который настолько неаккуратен и так пестрит ошибками, что от его чтения начинает болеть голова. За пять лет авторы этой книги проанализировали сотни примеров «плохого» кода (в основном – собственного), пытаясь определить, чем плох тот или иной код и как его можно улучшить. К какому выводу они пришли? Необходимо писать такой код, который читатель сможет понять максимально быстро, причем, даже если этот читатель – сам создатель этого кода.
В данной книге рассматриваются базовые принципы и практические методы, которые можно применять всякий раз при написании кода. В каждой главе на примере несложных образцов кода, написанного на разных языках программирования, изучается отдельный аспект создания кода и демонстрируется, как сделать код простым для понимания.
Книга «Читаемый код, или Программирование как искусство» авторов Дастин Босуэлл, Тревор Фаучер оценена посетителями КнигоГид, и её читательский рейтинг составил 7.80 из 10.
Для бесплатного просмотра предоставляются: аннотация, публикация, отзывы, а также файлы для скачивания.
Читаемый код, или Программирование как искусство.
Босуэлл Д.
Эта книга с полки — есть небольшие повреждения. Чтению они не мешают.
Описание
Тэги — это описание книги или товара в одном-двух словах. Используйте их, чтобы помочь другим пользователям выбрать книги и товары
Нельзя
― нецензурно выражаться
― спойлерить
― вставлять ссылки
― писать личную информацию
— добавлять теги больше 25 символов
| Издательство: | Питер |
| Год: | 2012 |
| Страниц: | 208 |
| Переплёт: | мягкий |
| Размеры: | 24,00 см x 17,00 см x 0,90 см |
| Формат: | 70х100/16 |
| Код: | 870123 |
| Автор: | Босуэлл |
| Тематика: | Книги с полки |
| Тираж: | 1500 |
Отзывы
Отзыв должен быть уникальным и содержательным: копировать отзывы целиком или частями с других сайтов нельзя.
Нецензурная брань запрещена.
Отзыв должен относиться к товару, на который он написан.
Пересказ аннотации, содержания, занимающие большую часть отзыва, не допускается.
Ссылки, почтовые адреса и личные данные публиковать в отзывах нельзя.
Мы не одобряем спойлеры.
