Всем привет! В этом сообщении в блоге я хочу объяснить вам все о моем понимании чистого кода и о том, как я реализовал его в проекте разработки программного обеспечения.

Что такое чистый код?

Чистый код субъективен, и у каждого разработчика есть личное мнение. Есть некоторые идеи, которые считаются лучшими практиками и тем, что представляет собой чистый код, однако четкого четкого определения того, что такое чистый код, не существует.

На мой взгляд, после прочтения нескольких книг и статей о чистом коде, чистый код можно свести к одному предложению: чистый код — это код, который легко понять и легко изменить.

Простота понимания означает, что код легко читается независимо от того, является ли читатель автором кода или кем-то еще. Смысл кода ясен, поэтому он сводит к минимуму необходимость догадываться и вероятность недопонимания. Код также легко понять на каждом уровне, например:

  • Легко понять поток выполнения всего приложения.
  • Легко понять, как разные объекты взаимодействуют друг с другом.
  • Легко понять роль и ответственность каждого класса.
  • Легко понять, что делает каждый метод.
  • Легко понять, какова цель каждого выражения и переменной.

Простота изменения означает, что код легко расширять и рефакторить, а также легко исправлять ошибки в кодовой базе. Этого можно достичь, если человек, вносящий изменения, понимает код, а также уверен, что изменения, внесенные в код, не нарушают какие-либо существующие функции. Чтобы код было легко изменить, есть несколько способов сделать это, например:

  • Классы и методы небольшие и несут только одну ответственность.
  • Классы имеют понятные и лаконичные общедоступные API.
  • Классы и методы предсказуемы и работают так, как ожидалось.
  • Код легко тестируется и имеет модульные тесты (или их легко написать).
  • Тесты легко понять и легко изменить.

Некоторые лучшие практики чистого кода

Значимые имена

Имя переменной, функции или класса должно отвечать на все важные вопросы. Он должен рассказать вам, почему он существует, что он делает и как он используется. Если имя требует комментария, то имя не раскрывает своего намерения. Например:

int d; // elapsed time in days

vs

int elapsedTimeInDays;

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

Функция

В чистом коде функция должна быть:

  • Маленький.
  • Сделайте одну вещь.
  • Используйте описательные имена.
  • Не имеют побочных эффектов.
  • Разделение командных запросов.

Комментарии

Когда мы сможем писать комментарии?

  • Юридические комментарии
  • Информативные комментарии
  • Объяснение намерения
  • Уточнение
  • Предупреждение о последствиях
  • TODO Комментарии
  • усиление

Плохие комментарии

  • бормотание
  • Избыточные комментарии
  • Вводящие в заблуждение комментарии
  • Обязательные комментарии
  • Комментарии журнала
  • Шумные комментарии
  • Страшные комментарии

Примеры:

Закомментированный код

Не закомментируйте код. Например:

Как я реализовал чистый код в проекте разработки программного обеспечения

В проекте «Разработка программного обеспечения» я реализовал некоторые из лучших практик чистого кода, такие как создание осмысленных имен для переменных и функций, создание функций для выполнения одной задачи и удаление ненужных комментариев.

Вывод

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

Спасибо за чтение :)