Когда я закончил учебу и начал заниматься разработкой программного обеспечения, я никогда не думал, что написание чистого кода является важной частью разработки программного обеспечения. Раньше я думал, что это здорово, если разрабатываемое программное обеспечение работает правильно. Это достаточно хорошо, и поэтому я думал, что дизайн является исключительно важным видом деятельности.
Однако, когда я присоединился к Sahaj, я прошел через программу под названием Gurukul, в которой я узнал, насколько важно писать чистый код. Не то чтобы я сейчас в этом преуспеваю. С каждым днем я изучаю все больше и понимаю, что писать чистый код - это не то, чему можно научиться в одночасье. Это требует практики и терпения. Нам нужно запачкать руки написанием кода, поиском запаха кода (понять и определить, что такое плохой код), а затем провести его рефакторинг.
Итак, вот что я испытал, почему написание чистого кода является важной частью разработки программного обеспечения:
- Легко читать и понимать.
- Легко отлаживать и рефакторинг.
- Поддерживаемый и расширяемый.
- Легко работать новым разработчикам.
- Требуется меньше времени на обслуживание.
Вот некоторые характеристики чистого кода:
1. Код должен легко читаться, читателю он должен нравиться.
2. Он сфокусирован, т.е. каждый класс, каждая функция служит одной цели.
3. Он проходит все написанные модульные тесты.
4. Он содержит правильное количество требуемых объектов.
5. Нет дублирования кода.
6. Код выразительный, он четко говорит, что делает.
7. Все просто :)
8. Небольшие изменения в коде не должны ломать важные вещи.
Как написать чистый код:
Что ж, вы не оцените хороший код, пока не увидите плохой код. Итак, всякий раз, когда мы пишем фрагмент кода, мы должны попытаться потратить некоторое время на проверку наличия запаха кода и подумать о его рефакторинге. Запахи кода обычно не являются ошибками, они не являются технически некорректными и не препятствуют работе программы. Вместо этого они указывают на недостатки в дизайне, которые могут, например, замедлить развитие. Вот несколько основных способов начать писать чистый код.
Значимые имена:
Имя должно раскрывать намерение. Может потребоваться некоторое время, чтобы подобрать правильное слово для переменной, функции или классов.
По сути, он должен рассказать, почему он существует, для чего он нужен и как он используется. Дополнительный комментарий не должен указывать на назначение переменной, функции или класса.
например, переменные:
int a; // required amount in rupees.
Вместо этого у нас должно быть что-то вроде:
int amountInDollars или int amount. Но мы можем предпочесть его как amount, на случай, если нам понадобится перейти на доллары в будущем.
например, классы:
Имя класса всегда должно быть существительным. а именно Customer, Account и т. д. Это никогда не должно быть Verb. например, AccountManager или OrderManager
например, названия методов:
Имена методов должны быть глаголами, объясняющими их значение.
int calculateAreaOfCircle(final int radius){
…
}
Нам также нужно быть последовательными, когда дело касается методов. Подобно тому, как мы использовали calculateAreaOfCircle, мы должны придерживаться метода calculate, а не использовать compute или rating. В названии должно быть единообразие.
Функции:
Что касается функций, они должны служить только одной цели. Если есть несколько цепочек if-else, их следует обрабатывать в рамках отдельных функций. В идеале количество строк, разрешенных в функции, может быть действительно меньше, если она служит правильной цели. Что касается параметров функции, они должны быть окончательными, потому что они должны быть неизменяемыми. Функция не должна иметь права изменять параметры, которые ей передаются. Она должна использовать ее для выполнения своей цели.
Комментарии:
Когда вам нужно написать комментарий, чтобы объяснить функциональность, подумайте над этим и попробуйте написать код, который достаточно хорошо это выражает. Потому что иногда комментарий может оставаться прежним, а назначение функции может меняться. т.е. комментарии могут лгать, не всегда, но иногда, но код всегда говорит правду. В идеале при кодировании нет необходимости использовать комментарии.
Если вы чувствуете, что хотите их использовать, возможно, вы ошибаетесь, и пора задуматься и понять, почему существует необходимость в использовании комментариев.
Форматирование кода:
Код по всему проекту должен быть отформатирован единообразно, потому что, если это не так, это заставляет читателя задаться вопросом о разнице между используемыми стилями. Код во всей базе проекта должен быть написан одним человеком. Не существует необходимого или лучшего способа форматирования кода. Вместо этого команда должна согласовать стандарт и установить их в правилах стиля проверки, чтобы обеспечить единообразие всего кода.
Я понял, что написание чистого кода требует времени, но постепенно, постепенно практикуясь, мы сможем улучшить нашу скорость и эффективность. Потому что, если и когда возникнет проблема в будущем, наш чистый код творит чудеса, помогая нам решить возникшую проблему / проблему. Это помогает не только тому, кто написал код, но и всем, кто хочет решить проблему. Хотя написание кода в первый раз занимает больше времени, оно того стоит.
И это не конец этой темы. У меня обязательно будет часть 2, в которой я подробно расскажу о способах написания чистого кода. Рекомендую прочитать книгу Роберта Мартина «Чистый код». Это такая замечательная книга, которая заставит вас увидеть и уродливые, и красивые стороны кода и заставит вас гордиться тем, что вы написали лучший код.
