Хороший программист всегда должен помнить, что нужно писать код для людей, а не только для машины.

Многие люди знают, что им нужно кодировать, но чтобы знать, как кодировать, требуется хорошая практика. Этот процесс включает в себя множество шагов, которые необходимо выполнить. Один из таких шагов - написание более чистого кода.

Написание чистого кода не только важно, но и позволит вам на шаг опередить всех и принесет пользу вашим коллегам или тем, кто читает ваш код при его отладке и рефакторинге.

У разных людей разные идеи написания более чистого кода, но вот несколько основных советов, которым может следовать каждый.

  • Соглашение об именах. Именование классов и переменных не менее важно, чем их функциональность. Каждой переменной всегда следует давать осмысленное имя. Это означает, что имя должно рассказывать читателю об использовании этой переменной или класса.
    Например: чтобы указать количество учащихся в классе.
a = 50 // Bad practice
no_of_students = 50 // Good practice
noOfStudents = 50 // Also a good practice
  • Принцип единой ответственности: этот принцип гласит, что каждый класс или метод должны обрабатывать единственную ответственность, что означает, что у них должна быть только одна цель. Если кто-то захочет изменить его в будущем, у него должна быть только одна причина для его изменения.
    Это может упростить сопровождение вашего кода. Отладка и рефакторинг в этом случае также будут простыми.
  • Не повторяйтесь (СУХОЙ): какую бы строчку кода мы ни писали, мы должны убедиться, что она не повторяет те же функции.
    Для реализации этого принципа соблюдайте принцип единой ответственности, изложенный выше, чтобы уменьшить наши функции. Попробуйте написать многоразовый код. Но никогда не абстрагируйтесь слишком рано. Это может привести вас к очень сложному коду, вместо того, чтобы упростить его.
    Установите число для себя. Скажем, после 2, 3 или 4 повторений вы должны сделать функцию общедоступной.

Дублирование намного дешевле неправильной абстракции.

  • Форматирование. Форматирование кода не менее важно, чем его функциональность. Он играет основную роль, когда ваш код проходит процесс проверки. Никто не хочет читать 200 слов кода при горизонтальной прокрутке. А плохой отступ может испортить настроение рецензенту. Так что будьте осторожны при форматировании кода.
    Правильный отступ и форматирование важны для человека, который читает ваш код.
    В редакторах есть несколько расширений для форматирования кода одним щелчком мыши.
    Например: - Вы можете установить модуль форматирования по умолчанию на P rettier в файле VS Code settings.json.
  • Неиспользуемый код. Бывают случаи, когда многие разработчики оставляют в коде неиспользуемые импорты, переменные и методы. Это не повредит вашему коду, но увеличивает количество строк кода. Если мы хотим, чтобы наш код выглядел более аккуратно, всегда нужно быть с этим очень осторожным.
  • Сохраняйте простоту. Это одна из наиболее важных частей более чистого кода.
    Со временем мы склонны делать наш код более сложным.
    Если сделать ваш код простым, потребуется больше строк кода, тогда сделайте это.

Идеальный код не всегда возможен, но важно стараться писать код как можно более чисто. Программирование - это искусство. Позвольте другим программистам наслаждаться вашим кодом.

Вы можете следовать этим методам в повседневном кодировании. Наверняка есть еще много способов добиться этого. Дайте мне знать в комментариях, если у вас есть еще идеи.