Как найти ненужные части вашего кода [Часть XLIII]

Ваш код неприятен, потому что, вероятно, существует множество случаев, когда его можно было бы отредактировать или улучшить.

Большинство этих запахов — всего лишь намеки на что-то неладное. Следовательно, их не обязательно исправлять как таковые… (Хотя вам стоит над этим разобраться.)

Запах предыдущего кода

Вы можете найти все предыдущие фрагменты кода (Часть I – XLII) здесь.

Продолжим...

Код Smell 211 – Tab поверх пробелов

TL;DR: не используйте вкладки. Это не «личное решение по стилю»

Проблемы

Смешанные стандарты

* Читабельность * Ошибки компиляции на некоторых языках. * Смешанные стандарты

Решения

1. Используйте пробелы. Всегда.

2. Используйте автоматические инструменты, чтобы избежать табуляции в коде.

Контекст

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

обычно рекомендуется использовать выбранный метод отступов внутри проекта.

У использования пробелов перед табуляцией есть несколько преимуществ.

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

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

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

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

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

Пример кода

Неверно

def calculate_average(numbers):

total = 0 

count = 0 

    for number in numbers: 

total += number 

        count += 1 

    average = total / count 

return average 

numbers = [1, 2, 3, 4, 5]

print("The average is:", calculate_average(numbers))

Верно

def calculate_average(numbers):

total = 0 

count = 0 

for number in numbers: 

    total += number 

    count += 1 

average = total / count 

return average 
numbers = [1, 2, 3, 4, 5]
print("The average is:", calculate_average(num

Обнаружение

[X] Автоматически

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

Теги

• Стандарты

Заключение

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

Использование пробелов для отступов обычно рекомендуется для обеспечения единообразия, читаемости и доступности.

Отношения

Код Smell 164 – смешанные отступы< /п>

Code Smell 48 — Код без стандартов

Кредиты

Фото Фейсала Вахида на сайте Unsplash

Трудно правильно написать даже самый маленький фрагмент кода.

Джошуа Блох