Гигиена - это то, о чем мы, люди (и программисты тоже) должны заботиться, чтобы быть здоровыми и достойными! Кто бы мог подумать, что гигиена существует и для кода?
Соглашения о кодировании - это рекомендации по стилю программирования. Сюда включены лучшие практики и принципы программирования. Здесь мы обсудим некоторые соглашения о кодировании.
Вначале написание чистого кода может потребовать больше размышлений и внимательности при написании кода, это может вызвать у вас ощущение, что вы зря тратите время, но эта привычка принесет большую пользу вам, другим и проекту в долгосрочной перспективе. Вот некоторые из наиболее заметных преимуществ написания чистого кода:
- Легче отслеживать ошибки и ошибки
- Лучшая читаемость, люди могут понять цель нашего кода намного быстрее
- Хорошая ремонтопригодность, люди могут легко добавить или изменить ваш код при необходимости.
- Дает вам хорошее самочувствие и заставляет других ценить вас
Чтобы начать писать чистый код, нам нужно избавиться от вредных привычек и привычек, которые могут еще сохраняться при написании кода. Перечислим то, чего вам следует избегать. Чтобы сделать эту статью интересной, я буду использовать код Typescript / Javascript и React Native для примеров кода.
Распространенные плохие практики
Магические числа
Самый распространенный пример использования магических чисел в вашем коде - это когда вы используете бессмысленные буквы в качестве имен переменных для хранения чисел.
Ненужные комментарии
Вопреки тому, что вы, возможно, слышали о написании комментариев, чтобы сделать ваш код понятным, писать слишком много ненужных комментариев, особенно когда сам код не требует пояснений. Вы должны писать свой код с мыслями о том, чтобы люди понимали ваш код без необходимости использования комментариев.
Повторение кода
Если вам нужно скопировать и вставить часть кода несколько раз, чтобы сделать одно и то же снова и снова, то это красный флаг, который требует от вас рефакторинга раздела в многоразовую реализацию. Ниже приведен пример повторения кода во внешнем фреймворке, таком как React Native.
Почти описательные имена
Вам может показаться, что вы уже создали описательную функцию или имя переменной, назвав ее в соответствии с ее основным назначением. Но иногда вы можете упустить какое-то дальнейшее семантическое использование, которое необходимо указать в имени функции. Вот пример:
Чрезмерная вложенность
Пример чрезмерной вложенности, которую вы можете сделать в JS, - это цепочка множества обещаний с использованием метода .then(), это также называется адом обратного вызова.
В JS есть новое ключевое слово async & await, которое действительно может помочь сделать код более читаемым и легким для написания.
Некоторые реальные примеры
В настоящее время я работаю над проектом мобильного приложения в своем университете, позвольте мне продемонстрировать несколько примеров чистого кода в базе кода нашего приложения.
Мы абстрагировали множество полезных функций API во внешнем интерфейсе, чтобы другие разработчики могли легко повторно использовать эти функции, не беспокоясь об использовании повторяющегося синтаксиса внешней библиотеки. Эта практика помогает сделать экраны более чистыми и лаконичными, поскольку мы перемещаем большую часть кода реализации функций с экранов.
Мы также упростили стили компонентов для других разработчиков, сохранив все цветовые константы в одном файле, чтобы избежать жесткого кодирования значений цвета в стилях компонентов. Таким образом, если мы хотим изменить цвет отключенных кнопок, все, что нам нужно сделать, это изменить значение цвета для значения константы цвета button.disabled, и все приложение изменит цвета отключенных кнопок на новое значение цвета.
До сих пор реализация чистого кода в нашем проекте была очень полезной для меня и других разработчиков, поскольку каждый из нас может легко повторно использовать наши функции и компоненты, а также легко отлаживать вещи, потому что большая часть нашего кода не требует пояснений.
Подводя итог, написание чистого кода поначалу может не казаться второстепенным, но как только вы привыкнете к нему и почувствуете его преимущества, это обязательно станет привычкой, которая сделает вас лучшим программистом.
