Программисты читают код намного чаще, чем пишут его, поэтому важно писать понятный, последовательный, однозначный код. Автор книги С++17 in detail написал о способах избегать путаницы. Делимся его материалом к старту курса по разработке на С++.
Рубрика «читабельность»
Способы переписать логические параметры в С++
2022-03-05 в 14:00, admin, рубрики: c++, Cpp, IT-стандарты, skillfactory, Блог компании SkillFactory, код, Программирование, С++, с++17, С++20, с++23, Совершенный код, структуры, читабельность«Доктор, меня игнорируют», или Как писать письма так, чтобы их читали
2022-01-10 в 19:56, admin, рубрики: email, взаимодействие, команда, коммуникация, коммуникация в команде, Лайфхаки для гиков, нескучная работа, общение, Подготовка технической документации, понимание, удаленная работа, управление персоналом, управление проектами, читабельность«Мои письма никто не читает.»
«Я уже всё всем написал, а коллеги продолжают спрашивать одно и то же. Бесит.»
И особенно популярное: «Мы ещё неделю назад написали, что удалим эту таблицу из базы, и сказали адаптировать код! Так что мы не виноваты, что сайт (пайплайн, приложение, <подставь своё>) упали.»
Начну с весьма непопулярного заявления: ответственность за доставку и восприятие сообщения процентов на семьдесят лежит на отправителе (то есть на тебе). Конечно, если твой коллега — заядлый социопат и в принципе не читает никакиеЧитать полностью »
Что не так с вашей консольной программой?
2021-04-14 в 9:18, admin, рубрики: asyncio, click, diy или сделай сам, Prompt_toolkit, python, Блог компании Конференции Олега Бунина (Онтико), интерфейсы, консоль, Программирование, читабельностьМы еще в школе научились вызывать функцию print. Что может пойти не так в консольной разработке? Да, и если бы не растущая сложность программ, проблем бы у нас не было до сих пор. А в реальности — то в тексте трудно найти нужную информацию, то он не влезает в экран по ширине и по длине, а от многочисленности цветов рябит в глазах.
23 рекомендации для читабельного кода
2018-09-18 в 20:40, admin, рубрики: doxygen, entity component system, solid, tdd, антипаттерны, лаконичность, Программирование, статический анализ, Тестирование IT-систем, управление разработкой, читабельность, читабельный код, шаблон проектирования
Чужой код не всегда понятен. Несколько часов уходит на решение проблем, которые можно исправить за пару минут. В этой статье рассмотрим советы, как писать понятный код, который легко поддерживать.
Обратите внимание, что это не руководство по написанию «чистого кода». Под этим термином понимают разные вещи. Кому-то нравится легко расширяемый и общий код, кто-то предпочитает абстрагировать реализацию и работать только с конфигами, а некоторые просто любят субъективно красивый код. Это руководство фокусируется на читабельности, то есть на максимально эффективной передаче необходимой информации другим программистам.
Читать полностью »
Из-за тощих шрифтов интернет становится нечитабельным
2016-11-17 в 20:06, admin, рубрики: accessibility, веб-дизайн, графический дизайн, интернет, интерфейсы, контрастность, отношение контрастности и яркости, типографика, тощий шрифт, читабельность, шрифты
Пожилым людям трудно читать веб-страницы из-за изменений, произошедших со шрифтом в последние годы
Эксперты выяснили, что интернет становится нечитабельным из-за тенденции эволюции в сторону «тощих» шрифтов, которые ухудшают видимость слов на экране для пожилых людей или людей с ослабленным зрением.
В то время как раньше текст был рельефным и тёмным, и хорошо контрастировал с преимущественно белым фоном, теперь многие веб-сайты переходят на светло-серые или голубые шрифты.
Отмеченный наградами блоггер Кевин Маркс, основатель Microformats и бывший вице-президент веб-сервисов в BT, решил изучить проблему после того, как заметил, что стал испытывать всё больше трудностей при чтении текста на экране.
Читать полностью »
Как важно писать код, который могут читать люди
2016-08-09 в 7:13, admin, рубрики: javascript, Блог компании NIX Solutions, Программирование, читабельность, метки: читабельностьВам приходилось завершать проект одним махом, когда не было нужды снова смотреть в код? Вряд ли. Работая над старыми проектами, вам, вероятно, не хочется тратить время на выяснение, как работает этот код. Если код читабелен, то продукт легко сопровождать, а вы, ваши коллеги или сотрудники — счастливы.
Яркие примеры нечитаемого кода встречаются на соревнованиях JS1k, цель которых заключается в написании лучших JS-приложений, состоящих из 1024 символов или того меньше. То же самое можно сказать и про JSF*ck, крайне своеобразный стиль программирования, использующий только шесть разных символов для написания JS-кода. Глядя на выложенный на этих сайтах код, вы будете ломать голову, пытаясь понять, что здесь происходит. А представьте, каково это: написать подобный код и спустя месяц пытаться исправить баг.
Если вы регулярно сёрфите по сети или создаёте интерфейсы, то, вероятно, знаете, что для заполнения большой формы нужно много времени и терпения, которых хватает не всем пользователям. То же самое можно сказать и о коде. Чем легче его читать, тем приятнее долго работать с ним. Или как минимум не возникнет желания выкинуть компьютер в окно.
В этой статье будут рассмотрены разные уловки и хитрости, позволяющие избежать подводных камней и сделать код более читабельным.
Оригинал статьи: https://www.sitepoint.com/importance-of-code-that-humans-can-read/
Читать полностью »