Clean Code
13.3K subscribers
2.32K photos
5 videos
2.97K links
Советы по написанию кода, обзоры распространенных ошибок и многое другое.

Ссылка: @Portal_v_IT

Сотрудничество: @oleginc, @tatiana_inc

РКН: clck.ru/3Ht6ch
加入频道
Functional Envy

Функциональная зависть - один из «запахов кода». Для методов класса должны быть важны переменные и функции того класса, которому они пренадлежат, а не переменные и функции других классов. Когда метод использует методы доступа другого объекта для манипуляций с его данными, то он завидует области видимости класса этого объекта. Он словно мечнает находиться в другом классе, чтобы иметь прямой доступ к переменным, с которыми он работает.

Метод calculateWeeklyPay обращается к объекту HourlyEmployee за данными для обработки, он завидует области видимости HourlyEmployee и «желает» получить доступ к внутренней реализации HourlyEmployee. Впрочем, иногда функциональная зависть оказывается неизбежным злом.

#cleancode #functions
Forwarded from Clean Code
Group the blocks by meaning

Группируйте блоки по смыслу. Используйте психологический эффект восприятия — «Эффект близости»: близко расположенные фигуры при восприятии объединяются. Получить код, подготовленный для анализа и обобщения можно, расположив рядом строки, объединенные смыслом или близкие по функционалу, разделив их пустой строкой.

#formatting
Facade Pattern

В этой статье приводится краткое руководство по использованию паттерна Facade. Данный паттерн проектирования используется в качестве “обертки”, скрывающей детали реализации. С паттерна Фасад начинается цикл статей по паттернам проектирования.

#designpatterns
Очевидное поведение не реализовано

Согласно «принципу наименьшего удивления», любая функция или класс должны реализовать то поведение, которого от них вправе ожидать программист.
Допустим, имеется функция, которая преобразует название дня недели в элемент перечисления, представляющий этот день.

Day day = DayDate.StringToDay(String dayName);

Логично ожидать, что строка "Monday" будет преобразована в Day.MONDAY. Также можно ожидать, что будут поддерживаться стандартные сокращения дней недели, а регистр символов будет игнорироваться.
Если очевидное поведение не реализовано, читатели и пользователи кода перестают полагаться на свою интуицию в отношении имен функций. Они теряют доверие к автору кода и им приходится разбираться во всех подробностях реализации.

#tips
Forwarded from Clean Code
Avoid positional markers

Избегайте позиционных маркеров. Они обычно просто добавляют шум. Позвольте функциям и именам переменных вместе с правильными отступами и форматированием придать визуальную структуру вашему коду.

#comments
Bridge Pattern

Паттерн Мост считается одним из важнейших среди паттернов проектирования. Как правило, он используется в больших бизнес-проектах, поскольку легко позволяет упрощать классы, отделяя реализацию логики низкого уровня от определения класса высокого уровня (который обычно абстрагируется или наследуется). Цель этого руководства — раскрыть особенности паттерна Мост на простых примерах.

#designpatterns
Commented Code

Приходилось ли вам работать с кодом, который содержит закомментированный код? Привычка оставлять такого рода комментарии является признаком плохого тона, и вот почему:

У других программистов, видящих закомментированный код, не хватает храбрости удалить его. Они полагают, что код оставлен не зря и слишком важен. В итоге скапливается ненужный балласт.

Это всеобщая проблема программистов, и не только начинающих. Нам всегда нужно хорошо продумывать алгоритмы и архитектуру, чтобы быть уверенными в их работоспособности и эффективности. Тогда у вас не возникнет даже мысли оставить закомментированный код.

#comments
Beautify Extension

Советуем полезное расширение Beautify для Visual Studio Code и Brackets, позволяющее форматировать JavaScript, JSON, CSS и HTML-код. Must-have для тех, кто неравнодушен к рефакторингу.

Visual Studio Code | Brackets | Online

#tools
Have no side effects

Бывает, что результат работы функции оказывается совсем не таким, как планировалось. И здесь стоит вспомнить о таком неприятном явлении, как побочные эффекты в функциях. Проблема эта очень коварная.

Побочным эффектом в коде ниже является вызов Session.initialize(). Функция checkPassword может вызываться только в определенные моменты времени, когда инициализация сеанса может быть произведена безопасно. Если же нарушить такую временную привязку, сеансовые данные могут быть безвозвратно потеряны.

Возьмите себе за правило писать функции без побочных эффектов. Удачного дня!

#cleancode #functions
It's okay to write dirty code

Трудно отрицать, что попытка писать чистый код на самом деле тормозит большинство из нас, однако делать это все же неоходимо. В данной статье приводится несколько путей написания чистого кода.

#cleancode
Forwarded from Clean Code
if - else - while

Блоки в командах if, else, while и т.д. должны состоять из одной строки, в которой обычно содержиться вызов функции. Это не только делает вмещающую функцию более компактной, но и способствует документированию кода, поскольку вызываемой в блоке функции можно присвоить удобное содержательное имя.

#functions
Help Tools: Spell Checkers

Настоящие профессионалы пишут не только чистый, эффективный код, но и грамматически правильные комментарии.

В этом нам помогут популярные расширения для текстовых редакторов кода и IDE: Spell Checkers.

Visual Studio | VS Code

#tools
Observer vs Pub-Sub design patterns

Статья на простых примерах объясняет сущность паттернов Наблюдатель и Издатель-Подписчик.

При прочтении обратите пристальное внимание на их отличия, ведь эти паттерны легко спутать.

#designpatterns
Functions instead of comments

Не используйте комментарии там, где можно использовать функцию или переменную. Постарайтесь переработать свой код так, чтобы их можно было удалить.

И запомните: хороший код не требует комментариев.

#comments #functions
Divergent Change

Стремление к структурированию программ оправдано, ведь мы хотим облегчить их модификацию.
Однако если внесение изменений в одно определенное место не удается, возникает следующая проблема.

Расходящиеся модификации имеют место тогда, когда один класс часто модифицируется различными способами по разным причинам. Если, глядя на класс, вы отмечаете для себя, что эти три метода
придется модифицировать для каждой новой базы данных, а эти четыре метода придется модифицировать при каждом появлении нового финансового инструмента, это может означать, что вместо одного класса лучше иметь два.

При каждой модификации должен изменяться один класс, и вся типизация в новом классе должна выражать эти условия. Тогда каждый класс будет иметь свою зону ответственности.

#cleancode
3 Timeless Principles of Quality Code

При написании кода мы часто пользуемся популярными на сегодняшний день практиками и советами, но эти стандарты изменчивы. Однако существуют прочно утвердившиеся принципы написания кода, которые со временем не претерпевают изменений.

С ними вас познакомит статья.

#cleancode #programming
Bracket Pair Colorizer

Популярное расширение для Visual Studio Code, позволяющее отмечать различным цветом открывающую и соответствующую ей закрывающую скобки. Определить, какой код к какому блоку относится, будет легко и, самое главное, наглядно.

Source

#tools