Следуйте этим рекомендациям по кодированию и применяйте эти передовые методы, чтобы обеспечить качество кода и код без ошибок.
Чтобы обеспечить качество кода и код без ошибок, мы должны следовать некоторым рекомендациям и рекомендациям. Я делюсь рекомендациями, которым следую я и моя команда.
1. Вы должны настроить ESLint и Husky в своем проекте
ESLint быстро находит проблемы в вашем коде, а также предлагает решения для их устранения. Это также упрощает задачу рецензента кода.
Husky улучшает коммиты вашего кода. Если мы правильно настроим Husky, он не позволит разработчику зафиксировать свой код, если в коде есть какая-то ошибка или тестовые случаи не выполняются.
2. Следуйте принципу SOLID
Принцип SOLID очень важен. Вы должны помнить о твердых принципах при написании кода. Например, одна функция не должна выполнять более одной задачи. (Единственная ответственность).
Принцип SOLID означает:
- S — принцип единой ответственности
- O — открытый принцип
- L — принцип подстановки Лисков
- I — Принцип разделения интерфейсов
- D — принцип инверсии зависимостей
3. Документация в коде
Вы должны написать техническую документацию для своего кода, чтобы любой новый разработчик мог легко понять.
Вы можете использовать JSDoc для документации. Этот документ также можно экспортировать, и он может быть полезен для понимания кода. В JSDoc вы должны описать функции или компоненты, которые вы создали. Следует указать точные типы данных для реквизита/аргументов. Вы не должны указывать надмножество типов данных (например, Object для всех типов).
Подробнее о JSDoc можно прочитать здесь
4. Следует избегать чрезмерного использования обработчиков производительности
Подробно изучите React Hooks и используйте их с умом. Не стоит везде использовать useMemo, useCallback, React.memo.
5. Не повторяйтесь (СУХОЙ)
Вы должны создавать повторно используемые компоненты и функции, чтобы избежать повторного написания одного и того же кода.
Бывший. полезные функции, хуки, hoc и т. д.
6. Позаботьтесь о доступности
Ваше приложение должно быть доступно для всех, таких как люди с ограниченными возможностями, мобильные устройства, медленные сети и т. д. Оно также должно легко работать с клавиатурой.
Подробнее о доступности можно прочитать здесь.
7. Написание модульных и интеграционных тестов
Мы должны написать тестовые примеры для проверки бизнес-логики. Это помогает, если мы делаем улучшения, и любая затронутая бизнес-логика может быть зафиксирована только на этапе разработки.
8. Отделяйте зависимости разработки от зависимостей производства
9. Используйте именованный импорт вместо деструктурирования.
Неверно
import { isArray} from “lodash”;
Верно
import isArray from “lodash/isArray”;
10. Частый коммит с соответствующим сообщением
Мы должны зафиксировать наш код, если мы завершим какую-либо небольшую функцию, и должны написать код в конце дня.
11. Используйте более строгое объявление переменной, функции
Избегайте использования var. Начните использовать let и const. Если что-то не изменится, мы должны использовать только const.
12. Избегайте использования переменных в цикле
Мы должны избегать объявления переменных в цикле. Это может излишне потреблять память.
13. Очистить память
Хотя javascript заботится об очистке памяти, иногда нам нужно очистить память, например, в случае settimeout или setinterval.
В React вы можете позаботиться об этих вещах с помощью componentWillUnmount или хука useeffect, возвращающего функцию, в которой вы можете отписаться, очистить время ожидания или очистить интервал.
14. Оптимизация производительности
Есть несколько способов оптимизировать производительность.
- Минимизируйте и сожмите пакет
- CDN и кэширование на уровне браузера
- Использование локального хранилища и хранилища сеансов
- PWA-приложения
- Пагинация или бесконечная прокрутка
- Использование подавления дребезга/дросселя https://santoshyadav979439.medium.com/debouncing-in-java-script-b8d63c34feec
- Использование контроллера прерывания
- Крючки производительности React, если вы разрабатываете приложение в React
- Ленивая загрузка и т.д.
15. Безопасность
Мы также должны позаботиться о части безопасности.
Вот несколько вещей, которые мы можем сделать:
- Ограниченная загрузка файлов
- Проверка ввода формы и очистка приложения во внешнем и внутреннем интерфейсе. Для этого доступно несколько библиотек. Таким образом, мы можем смягчить XSS-атаки. Мы также должны включить режим защиты XSS.
- Использование капчи
- Использование строгой политики безопасности контента. (CSP)
- Отключить встраивание iframe
- Сохраняйте ошибки общими
- Используйте ограниченные функции браузера и API
- Избегайте использования сторонних библиотек. В библиотеке может быть вредоносный код.
Это для этой темы. Спасибо за чтение.
Дополнительные материалы на PlainEnglish.io. Подпишитесь на нашу бесплатную еженедельную рассылку новостей. Подпишитесь на нас в Twitter, LinkedIn, YouTube и Discord.
