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

Хорошо, затем, обычно, если мы только что закончили университет, профессиональную школу или университет, почти программист написал только код, если этот код работает хорошо, наша задача была выполнена, хе-хе (я сделал это до wkwkwk), и только мы и бог, которые могут понять 😂, но на самом деле это не так, я думаю, что если у нас есть мышление, которое работает только вечно, это совершенно неправильно, хе-хе, потому что программист не только писал код, но и как насчет разработки этих приложений и совместной работы, как насчет других людей, понимающих за поток нашего кода.

о да, эта статья будет примером с языком программирования Golang (язык Go), если вы никогда не пробовали использовать Golang, вы можете связаться со мной, чтобы обсудить другое программирование. Хе-хе, почему Golang? не в основном, но я написал эту статью Я делаю свой код с помощью Golang hehe

Отказ от ответственности, эта статья не является официально стандартным чистым кодом, а только моим личным мнением хе-хе

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

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

jengggg, в этой статье будет объяснено, как повысить наш код навыков, и, как минимум, наш код может понимать другого инженера в нашей команде:

  • имя переменной, функции или класса
  • имя папки
  • письменный комментарий при необходимости
  • сделать рефакторинг кода
  • удалить Мертвый код
  • Создать файл Readme
  • Создать документацию
  • Создать тестовый блок

Я объясню по каждому пункту, как показано ниже

1. Имя переменной, функции или класса

В основном программист Fresh Graduate будет писать переменную имени или базу функций при первом размышлении, или только 1-символьный алфавит, например a, b a1, b2, я думаю, что это не плохо для новичка, но в реальном случае в рабочей группе наш код должен быть читаемым для Наша команда. это пример неправильного кода

вы можете понять, что в коде переменная AB, написанная полностью в верхнем регистре, на самом деле все еще работает, но в мире программистов хе-хе :) есть правило о записи кода, следующая вторая переменная вы можете видеть, что эта переменная имеет два слова, обычно если ваша переменная имеет два слова, второе слово в первом алфавите должно быть в верхнем регистре, а остальные в нижнем регистре, я покажу вам допустимую переменную для написания кода:

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

2. Имя папки

Как насчет папки с именами, почему мы должны правильно использовать папку с именами, вы можете себе представить, у вас так много модулей в ваших приложениях и, конечно, столько папок, которые вы можете создать, если вы назвали папку только алфавитом, например «A», «B» . «ASD» когда-нибудь, если вы будете разрабатывать это приложение, вас действительно сбивает с толку имя папки. Например, если вы разрабатываете новый модуль, такой как «студент», вы можете написать свою папку с именем «студент» и другие.

3. Письменный комментарий при необходимости.

Прокомментируйте, как насчет комментария в нашем коде, комментарий в некоторых случаях важен, потому что, если вы пишете сложный код или вы пишете формулу о чем-то, вы можете поместить свой комментарий для каждой функции «например, эта переменная для цикла», «эта функция для генерации UUID ”Или что-то в этом роде, это комментарий для объяснения использования переменной или функции. Вы можете описать свой код, используя комментарии, но не комментируйте так долго, пишите только по существу, хе-хе.

4. Выполните рефакторинг кода.

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

5. Удалить мертвый код.

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

6. Создайте файл Readme.

Почему мы пишем, прочтите меня, так много случаев, когда вы должны писать, прочтите меня, один из них, если у вас есть новая работа в компании A, вы должны узнать об их коде, если этот код не прочитал меня, вы очень сбиваете с толку, потому что вы не знаю, что вы делаете дальше, поэтому, если мы напишем код после запуска, мы должны написать, как использовать приложения или как запустить наше репо / службу

7. Создать документацию

Вы можете себе представить, если у Facebook, Google API, Github нет документации о своих приложениях / API, мы, как разработчики, очень запутались в сторонних или используем приложениях, хе-хе, вы не знаете, как получить токен из Facebook API, как получить API Get All Repository и другие. Если мы работаем в команде, другие команды иногда могут использовать наши приложения / услуги.

8. Создайте модульное тестирование.

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

Если у вас есть обсуждение || ~

Просто свяжитесь со мной по адресу: