Написание кода, который может понять любой читающий программист, является обязательным навыком для разработчиков программного обеспечения. Факт: только 20% программистов обладают способностями.
«Любой дурак может написать код, понятный компьютеру. Хорошие программисты пишут код, понятный людям ». - Мартин Фаулер
Когда я начал заботиться о читабельности кода, я заметил, что мой код стал выглядеть следующим образом:
- легче поддерживать
- легче рефакторинг
- многоразовый
- последовательный
"Книга"
Чистый код Роберта« дядюшки Боба Мартина: руководство по созданию гибкого программного обеспечения» - это библия чистого программиста. В этой книге рассказывается о коде, поведении, автоматических тестах и т. Д.
Давайте приступим к практике! Написание значимых имен.
В одной из глав Чистого кода говорится о содержательном именовании. В этой истории вы будете читателем кода. Взгляните на эту функцию:
def calc(n1, n2) return n1 / n2 end
Как вы думаете, calc - хорошее название для этой функции? Дядя Боб сказал бы: нет! Почему?
- «Calc» - это сокращение: не надо!
- Функции что-то делают. Он должен быть назван с помощью глагола.
- Даже я переименовал «calc» в «вычислить», это все равно будет расплывчатым. Нам нужно улучшить семантику, придав имени функции больше смысла.
Эта функция делит два числа. Разделить - хорошее название для этого.
def divide(n1, n2) return n1 / n2 end result = divide(1, 2)
У нас все еще есть проблемы с этим. Параметры n1 и n2 не являются семантическими. Что, если мы назовем их дивидендом и делителем? То же самое и с переменной результата. Его следует называть чем-то вроде частного.
def divide(dividend, divisor) return dividend / divisor end quotient = divide(1, 2)
Намного более смысловой!
Спасибо за чтение! Не забывайте подписываться на меня в Medium, Instagram и LinkedIn.
