Орфография и читаемость очень важны для людей и не важны для машин.

TL; DR: берегите свои имена.

Проблемы

  • Читаемость

Решения

1. Проверьте правописание в своем коде.

2. Используйте IDE с проверкой орфографии.

Контекст

Многие из нас не говорят на английском как на родном.

Нам нужно особенно внимательно относиться к нашим текстам и именам.

В названии статьи есть опечатка в качестве доказательства контекста, а также кликбейт😀

Образец кода

Неправильный

Правильно

Обнаружение

[X] Руководство

  • Нам нужно прочитать код во время экспертной оценки.

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

  • В некоторых IDE есть предупреждения об опечатках.

Теги

  • Читаемость
  • Именование

Вывод

Обратите особое внимание на свои имена.

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

Больше информации





Внутри каждой хорошо написанной большой программы есть хорошо написанная маленькая программа.

C.A.R. Хоар



Эта статья является частью серии CodeSmell.