النَّظَافَةُ مِنَ الْإيْمَانِ
Бывают моменты, когда вы хотите заснуть после долгой ночной работы в темные дни обучения программированию, и вам приходит в голову: «Черт возьми, мой код работает как шарм!» а на следующий день вы открыли его снова и полностью забыли и потеряли из виду, как и почему существует переменная pleaseEndThisSuffering. Вы забыли, какова цель созданной вами функции kladsjlkjadslkja().
Самым простым объяснением этого является то, что вы раньше не использовали термин Чистый код!
Опять же, что такое чистый код?
На самом деле это определение предвзятости. Каждый человек может быть разным, но суть в том, что Чистый код - это код, который ваши друзья могут легко понять, повторно использовать или реорганизовать. Нет четкой цели по чистому кодированию. По сути, это простой, понятный, свободный от ошибок код, легко поддерживаемый другими людьми.
Чистый код обладает такими характеристиками, как:
- Чистый код - это элегантный код
- Чистый код более сфокусирован
- Чистый код легко поддерживать
Элегантный код в основном описывает, как код выглядит, работает и как он на самом деле охватывает и хорошо служит программисту для чтения. Программисты могут определить, для каких переменных предназначены функции. Сфокусированный код, каждая функция, каждый класс, каждый модуль действительно предназначен для одной цели. Таким образом, чтобы его не отвлекали, не отвлекали и не загрязняли какие-либо другие рабочие детали (другие функции или переменные).
Как написать чистый код?
Прежде всего, прежде чем писать какой-либо код, мы должны понять, каковы признаки неприятного запаха кода. Есть термин Кодовые запахи. Таким образом, запах кода - это совокупность любых характеристик кода, указывающих на то, что код не является чистым. Вы можете увидеть длинный список того, чего следует избегать и что делать, если вы столкнетесь с таким запахом кода здесь.
Есть также несколько принципов чистого кода, ниже несколько печально известных принципов:
- KISS (Keep It Simple Stupid) - принцип дизайна, позволяющий избежать ненужной сложности. Вы должны спросить себя: «Могу ли я написать этот код более простым способом?»
- DRY (не повторяйтесь). Этот принцип дизайна подчеркивает, что каждый фрагмент кода должен иметь единственное недвусмысленное представление в коде, чтобы не было повторения одного и того же блока кода.
- YAGNI (Вам это не понадобится. ). Здесь сказано, что мы реализуем только ту функцию, которая нам действительно нужна. Если это не имеет значения, мы должны удалить его или заменить другой функцией.
Пример в нашем проекте
Здесь мы видим, что это фиктивные данные для информации о нашем заказе. Мы видим, что названия переменных действительно описательны. Он подчеркивает свойство чистого кода именования переменных. мы также делаем координаты легко читаемыми.
Здесь мы также видим, что это простая обработка ошибок, выполняемая в нашем проекте. Если сообщение не читается, будет возвращено это сообщение об ошибке. Также применяется при разборе.
Последний пример будет учитывать это. Мы видим здесь, в первом routeState, что в коде есть несколько повторений. Мы определили три фильтра для локации. Таким образом, мы можем извлечь его и поместить в переменную, чтобы оно сохраняло значение, которое повторяется и затем используется в другой желаемой переменной. initFilter хранит базовое значение для всей Широты, Долготы, Скорости для одного экземпляра маршрута. В routeState мы снова используем переменную раньше, чтобы ее можно было назначить за один раз, и она не должна была быть такой длинной, как раньше.
В заключение
Я так много узнал как хипстер для этого проекта. Я узнал, что чистый код действительно важен для долгосрочного управления программным обеспечением.
Спасибо за прочтение!
