«Чистый код - это код, о котором позаботились. Кто-то нашел время, чтобы сделать это простым и упорядоченным. Они уделили должное внимание деталям. Они позаботились ». - Роберт С. Мартин
Чистый код - это код, который можно удобно читать, понимать и изменять. Это основная концепция, потому что вы пишете код не только для того, чтобы его понимали вы или компьютер, но и другие разработчики. Если ваш код чистый, легко читаемый - тогда разработчики могут отлаживать и добавлять свой код, не задумываясь дважды, что означает записанная переменная или функция. Если вам нужно объяснить код другим разработчикам, то это плохой код, работает да, но плохой.
«ЧТО ЭТО ДОЛЖНО ЗНАЧИТЬ ?!»
Да, большинство людей реагируют, когда читают плохой код нашего товарища по команде на курсе веб-разработки. Чистый код может сократить время нашего детектива в коде, сократить проклятое слово: D и сделать ваш код приятным документальным и элегантным.
Характеристики чистого кода
- KISS - Keep It Stupid Simple: сделайте свой код максимально простым, чтобы избежать ненужной сложности.
- Элегантный: чистый код должен приятно читать и вызывать улыбку, как при виде красивой машины.
- Сосредоточенность: каждая функция, класс или модуль должны быть сосредоточены на одной задаче.
- СУХОЙ - не повторяйся: не содержит дубликатов.
- Для этого есть тест
Как написать более чистый код?
Значимые имена
Используйте поясняющие имена. Выбор хорошего имени может сэкономить ваше время в долгосрочной перспективе и упростить отладку. Имя переменной, функции или класса должно объяснять само себя и рассказывать вам, почему они существуют, что они делают и как они используются. Старайтесь избегать использования комментариев при именовании.
Имя должно быть выразительным. Когда кто-то читает этот код, разработчикам будет трудно понять, что он означает.
Лучшее название было бы nowTime, оно само объясняет, что переменная - текущее время.
Имена классов. Классы или объекты должны иметь существительное или существительное словосочетание, например Customer, DashboardPage или Car. Избегайте таких глагольных слов, как Filter, Cry или Accept.
Имена функций - функция должна содержать глагол или глагольную фразу, например AcceptPayment, FilterData или DeleteAccount.
Функции
Функции должны быть все меньше и меньше. Означает, что блоки внутри операторов if, операторов else, операторов while и т. Д. Должны состоять из одной строки. Если строк несколько, вероятно, нужно создать новую функцию. Это не только добавляет документальной ценности, функция может сама объяснять, что она делает.
Из примера читатель легко понял, что функция предназначена для сброса значения поиска, а функция сосредоточена только на сбросе значения.
Комментарии
Избегайте использования комментариев для объяснения переменной или функции. Вы ошибаетесь, если пытаетесь доказать свою точку зрения на комментарий. Прямо сейчас в современном языке программирования проще объяснить переменную или функцию только по их именам. Правильное использование имен может предотвратить комментарии.
Реализация нашего проекта на чистом коде
В нашем проекте PPL мы реализуем чистый код со вспомогательными инструментами, чтобы сделать наш код более чистым. С более чистым кодом члены нашей команды могут быстрее и проще понять код.
Мы используем значимые имена, такие как isLoggedIn (), чтобы объяснить, что функция возвращает истину, если пользователь вошел в систему в браузере, в противном случае возвращает ложь. Также мы сохраняем небольшую функцию, чтобы она была сосредоточена на одной задаче.
Мы используем ключевое слово handle для функции, которая вызывается при запуске события onClick. Последовательная схема именования может сделать наш код более элегантным и снизить нагрузку на память читателя.
Инструменты, которые мы используем, чтобы сделать наш код чище
- Prettier - Prettier - это средство форматирования кода, которое форматирует наш код в соответствии с установленными правилами, такими как именование, отступ, максимальная длина и т. д.
- ESLint - ESLint - это инструмент для анализа и форматирования, позволяющий проверить стиль нашего кода и быстро найти проблемные шаблоны. Для ESLint существует множество популярных правил, таких как правила Google, правила airbnb и т. Д. Мы используем правила airbnb для нашего линтера, потому что это наиболее часто используемый и большинство людей кодируют свой JavaScript, следуя этим правилам.
Заключение
Подводя итог, мы используем чистый код, чтобы сделать наш код более читаемым и сделать других разработчиков более счастливыми при чтении нашего кода. Кроме того, чистый код может сократить время разработки в долгосрочной перспективе и упростить отладку в будущем и для других.
Это все, что у меня есть для Clean Code, не забудьте прочитать мои недавние статьи.
Для получения более подробной информации вы можете прочитать Clean Code: A Handbook of Agile Software Craftsmanship Роберта К. Мартина.
