Эта статья — краткая заметка о двух связанных друг с другом эмпирических правилах.
Поднимайте If вверх
Если внутри функции есть условие if, то подумайте, нельзя ли его переместить в вызывающую сторону:
Читать полностью »Рубрика «читаемость кода»
Поднимайте If вверх, опускайте For вниз
2025-05-22 в 10:01, admin, рубрики: обработка данных, оптимизация кода, условные конструкции, циклы, читаемость кодаКак нейминг влияет на качество кода?
2024-09-07 в 10:06, admin, рубрики: javascript, nodejs, ReactJS, качество кода, нейминг, читаемость кодаВведение
В этой статье я хочу обратить внимание на такой аспект разработки как нейминг.
Мы рассмотрим, почему важно уделять внимание названиям переменных и функций, и как грамотный подход к неймингу может сократить время и усилия на поддержку и развитие проекта. Надеюсь, мои мысли окажутся полезными. Буду рада обратной связи в комментариях.
Описание проблемы
Добавляйте единицы измерения в имена
2022-05-31 в 13:22, admin, рубрики: java, python, Блог компании Билайн Бизнес, единицы измерения, код, Программирование, Совершенный код, читаемость кода
Есть одна ловушка читаемости кода, которой легко избежать, если вы о ней знаете; тем не менее она встречается постоянно: это отсутствующие единицы измерения. Рассмотрим три фрагмента кода на Python, Java и Haskell:
time.sleep(300)Thread.sleep(300)threadDelay 300Сколько «спят» эти программы? Программа на Python выполняет задержку на пять минут, программа на Java — на 0,3 секунды, а программа на Haskell — на 0,3 миллисекунды.
Как это можно понять из кода? А никак. Вам просто нужно знать, что аргументом time.sleep являются секунды, а threadDelay — микросекунды. Если вы часто ищете эту информацию, то рано или поздно её запомните, но как сохранить читаемость кода для людей, никогда не встречавшихся с time.sleep?
Читать полностью »
Прочти меня: код, который не выбесит соседа
2021-03-16 в 8:44, admin, рубрики: c++, codestyle, python, Блог компании Яндекс, документация, документация кода, идеальный код, Лайфхаки для гиков, Программирование, С++, Совершенный код, читаемость, читаемость кода, читаемый код
Сегодня поговорим о том, как писать код, чтобы он не злил окружающих и не раздражал вас спустя годы работы, когда вы снова попытаетесь его прочесть.
Я расскажу о подходах, которые мы используем в Яндекс.Такси для написания читаемого кода на C++, Python, JavaScript и других языках.
Читать полностью »
Rust: зачем нужны макросы
2018-03-08 в 7:40, admin, рубрики: open source, Rust, Компиляторы, макросы, Программирование, рефакторинг, системное программирование, типы, читаемость кодаКак-то я сказал своему коллеге, что в Rust имеются макросы, ему показалось, что это плохо. Раньше у меня была такая же реакция, но Rust показал мне, что макросы не обязательно плохи.
Где и как их уместно применять? Смотрите под катом.