Возможно, вам надоело читать на эту тему в сотый раз. Но важно понимать ценность хорошего кода. Когда разработчик пишет чистый код, он создает великолепные программы или приложения, которые отлично работают и просты в обслуживании. Если разработчик решит игнорировать практику чистого кода, у него может быть великолепный дизайн, но я могу поспорить, что ошибки начнут появляться отовсюду, и обслуживание станет кошмаром.
Что такое чистый код?
Чистый код — это код, который легко читать, несложно понять и легко поддерживать для других коллег. Легко написать код, который будет понятен машине или вам, но в будущем это может оказаться сложной задачей.
Важно, чтобы другие разработчики могли понять ваш код. Это основная идея чистого кода. вы не пишете код для машины, вы не пишете для себя, вы пишете для других разработчиков. Люди в вашей команде или организации должны прочитать ваш код и изменить его, чтобы исправить ошибки или добавить новые функции.
- Чистый код выразителен
Это означает, что другие разработчики могут посмотреть на фрагмент кода и точно понять, о чем он. Имена классов, структура — все должно иметь смысл. Хороший код — это самодокументированный код. Другими словами, код не должен требовать страниц и страниц документации для его объяснения.
Если другой разработчик читает код впервые, он должен быть в состоянии понять, о чем он. Они могут не знать всего, но вы уже знаете, о чем эта часть кода — имена, имена классов, структура должны быть выразительными. - Чистый код — это просто
Чтобы код не превратился в гигантский лабиринт функций и классов, есть несколько правил, которым должны следовать хорошие разработчики. Принцип KISS, или Keep It Simple Stupid, для начала — системы работают лучше всего, когда они основаны на простоте, а не на сложности. Эта идея должна лежать в основе любого хорошего дизайна кода.
Еще одно правило — единая ответственность. Каждый класс или функция должны отвечать только за одну вещь. Например, если вы создаете рынок электронной коммерции, должен быть один класс для сбора данных о клиентах, один класс для получения информации о кредитной карте и так далее. Если класс делает много вещей, он быстро усложняется. - Чистый код также можно обслуживать
Удачи вам в его обновлении, проверке и добавлении новых функций в будущем, если вы не тратите время на написание хорошего кода. Плохо написанный код разочаровывает, и его трудно модифицировать, не вызывая впоследствии новых ошибок. Однако хороший код — это противоположное, потому что он выразительный и ясный, его легко обновлять и исправлять с течением времени как для исходного создателя, так и для других.
Почему разработчики этого не делают?
Но все это логически имеет смысл, не так ли? На бумаге это выглядит потрясающе, но многие разработчики просто не делают этого в реальности. Почему нет? Начнем с того, что у некоторых из них просто не будет базы знаний. Возьмем, к примеру, младшего разработчика. Они никогда не научились бы делать это для себя, если бы они только что работали над небольшими проектами или с более старшими разработчиками, которые не вдохновлены писать чистый код.
Еще одной проблемой является отсутствие мотивации. Скажем, вы работаете за несколько долларов в час с каким-то разработчиком с аутсорсинговой платформы. У этого человека не будет мотивации делать хорошую работу за несколько долларов в час. Вы можете выйти из сделки с веб-сайтом, но подождите несколько месяцев, и вы начнете замечать ошибки, которые должны были быть предотвращены.
Последним препятствием является нехватка времени. Посмотрим правде в глаза, на написание плохого кода уходит намного меньше времени, потому что он не такой тяжелый. Подготовка чистого кода требует много времени и тщательного обдумывания. Гораздо проще сразу же начать писать, не беспокоясь о потенциальном покупателе, других разработчиках или общем дизайне. Но когда разработчики сталкиваются с жесткими сроками, их единственным выбором может быть плохо написанный код. Вот почему важно предоставить менеджерам жесткие сроки, чтобы команда разработчиков могла потратить время на создание очень удобного кода.
Почему это важно?
Как мы установили ранее, в краткосрочной перспективе плохо написанный код может быть быстрее, но через несколько месяцев вы будете счастливее, вложив средства в чистый код. Когда вы потратите время и силы на создание своего кода, будет намного проще добавлять новые функции, исправлять ошибки и работать с другими разработчиками.
Как это сделать?
Здесь, в Arc10, прежде чем это будет сделано, у нас всегда есть кто-то еще, чтобы проверить наш код. Постоянный командный диалог помогает нам быстро исправлять ошибки, улучшать свои навыки и делиться новыми идеями.
У нас есть так называемый запрос на слияние, который делают все — это то, что делают все разработчики на рынке. Вы делаете запрос на слияние, чтобы увидеть разницу между новым и старым кодом, прежде чем вносить изменения в сам код. Все остальные разработчики в вашей команде проверяют код, дают отзывы и говорят, что я думаю, что он должен быть лучше, я думаю, что он должен быть другим, и что вы ведете беседу со своей командой. Это также хороший способ обмена информацией. Это очень важно, потому что иногда это способ помочь им улучшить свои навыки и использовать знания всех членов команды, когда у вас есть младшие разработчики.
Наконец, мы постоянно проводим рефакторинг. Мы постоянно пересматриваем наш код сверхурочно, чтобы найти способы его улучшения, как автор, который никогда не доволен своим романом.
