Привет! В этом посте я расскажу о чистом коде.

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

Чистый код - это код, который легко понять и легко изменить. Чистый код имеет определенные характеристики:

  • Элегантно - код должен быть приятным для чтения
  • Читаемость - код должен быть хорошо написан, чтобы пользователям было легче читать код, который они не писали.
  • Простой - код должен выполнять одно действие на основе принципа единой ответственности (SRP).
  • Testable - запускает все тесты.

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

  1. Значимые имена: имена переменных, функций, аргументов, классов, модулей, пакетов, исходных файлов и каталогов должны иметь хорошие имена. Они должны раскрывать намерение и быть произносимыми. Они не должны быть расплывчатыми, один и тот же термин не должен использоваться для двух разных целей, а имена не должны кодироваться, поскольку закодированные имена не всегда произносятся и в них легко ошибиться.
  2. Сделайте одно: функции должны делать только одно и иметь одну цель. Это соответствует принципу единой ответственности.
  3. Аргументы функции: функции должны иметь менее трех аргументов.
  4. Don’t Repeat Yourself (DRY): следует избегать дублирования кода при разработке программного обеспечения, поскольку оно является избыточным. Чтобы уменьшить это, было создано множество принципов проектирования и передовых методов.
  5. Модульные тесты: во время разработки программного обеспечения следует применять разработку через тестирование (TDD). Этот метод помогает легче исправлять ошибки в долгосрочной перспективе.
  6. Комментарии: комментарии должны быть сделаны обязательно и не должны состоять из заблокированного кода, так как это делает код менее элегантным.
  7. Соглашения: в коде должны применяться соглашения для определенной структуры или языка.

В моей команде мы пытались применить чистый код в нашем программном обеспечении. Один из примеров - применение метода «Не повторяйся», по крайней мере, для каждой ветки в нашем репозитории.

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

Наша команда также применила правило «Соглашения», в котором мы использовали одну буквенную переменную, как это принято в GoLang, в функциях, которые расширяются до структуры. (Его можно увидеть в «m * module» в некоторых функциях).

Кроме того, мы использовали инструмент линтинга GoLang: https://github.com/golangci/golangci-lint, чтобы убедиться, что наш код аккуратный и чистый. Пример: https://gitlab.cs.ui.ac.id/it-project-kki/2019/happyfresh-fleet-tracker/-/jobs/69348

На мой взгляд, чистый код действительно полезен при разработке программного обеспечения. При правильном применении он помогает разработчикам при необходимости перечитывать код, который они, возможно, написали в прошлом (который они могли забыть), или когда им приходится читать чужой код. Мало того, что если бы разработчики попытались исправить ошибку, это также сделало бы процесс более эффективным, так как не много времени было бы потрачено впустую, пытаясь прочитать нечеткие имена переменных или пытаясь прочитать код в середине кучи заблокированных комментарии (которые не нужны).

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

Источники:



Как писать чистый код?
« Мастера-программисты думают о системах как о рассказах, а не о программах, которые нужно писать - дядя Боб hackernoon.com»



Https://cvuorinen.net/2014/04/what-is-clean-code-and-why-should-you-care/