Я недавно просмотрел свой код, когда наш клиент запросил обновление, но когда я увидел код, который написал 2 года назад, я был шокирован. Я решил улучшить качество кодирования и прочитал книгу Чистый код Роберта К. Мартина, известного как Дядя Боб. . Это некоторые из выводов, которые я вынес из книги.
1 правило бойскаута:
У бойскаутов есть правило: «Всегда оставляйте палаточный лагерь более чистым, чем вы его нашли». Это также может относиться к нашей кодовой базе. Постарайтесь со временем немного улучшить качество кода. Вся кодовая база становится хорошей.
2 Связь между наименованием и областью действия:
2.1 Имя и область действия переменной. Длина имени переменной и область действия имеют линейную зависимость. Если область видимости переменной больше, то желательно больше длины переменной и наоборот.
2.2 Имя класса и имя функции: Длина имени класса и имени функции имеет обратную связь с областью видимости. Если область видимости класса больше, то имя желательно меньше и наоборот
3 Одно слово на концепцию:
Попробуйте связать слово с концепцией и придерживаться его. Мы можем взаимозаменяемо использовать get и fetch. Если мы ассоциируем одно слово с концепцией и придерживаемся его, мы можем легко перейти ко всей базе данных. Например, если мы установили выборку для выборки из базы данных, все связанные базы данных должны начинаться с выборки. Тогда нам будет легко понять код. Каждый раз, когда мы видим выборку, мы определенно можем убедиться, что это вызов базы данных.
4 Старайтесь не повторять название класса внутри членов:
Рассмотрим пример:
class User{ user_id, user_registration_number, user_address } class User{ id, registration_number, address }
Второй случай лучше прочитать
5 Разделите функцию на несколько функций, если есть ветвление:
подход 1
def send_user_notification(user_type): if user_type == “type 1”: ## code block 1 elif user_type == “type 2”: ## code block 2
подход 2
def send_type1_notification(): ## code block 1 def send_type2_notification(): ## code block 2
Если мы используем подход 2, код будет более читабельным, а код очень компактным
6 Не используйте сторонний код непосредственно в коде:
Если мы используем какой-либо сторонний код, убедитесь, что он должен быть обернут другой функцией, чтобы в будущем, если мы захотим перейти на другой инструмент, нам было очень легко изменить код.
Учтите, что мы используем стороннюю компанию под названием abc и метод aaa.
Непосредственно с использованием кода
function1{ abc.aaa() } function2{ abc.aaa() }
В будущем, если мы планируем изменить abc на xyz, нам придется обновить Function1 и function2.
Использование оберток
wrapper_function(){ abc.aaa() } function1{ wrapper_function() } function2{ wrapper_function() }
Здесь нам нужно только обновить wrapper_function и можно протестировать отдельно
7 Добавление комментария к коду:
В связи с комментарием он говорит, что не комментируйте код без надобности. Каждый нежелательный комментарий - это неспособность программиста эффективно выразить код. Вот некоторые из мест, где нам нужно прокомментировать код:
1 регулярное выражение
2 предупреждения и комментарии Todo
3 JavaDoc для внешних API
8 Всегда следуйте командному правилу:
Каждый в команде должен правильно следовать правилу.
Помимо этого, мы можем делать только одно: оставаться в курсе наших технологий, над которыми мы работаем, и следовать лучшим практикам для этой технологии.
Удачного кодирования!