Я считаю, что никто не хочет писать грязный код, но что, если у нас есть крайний срок, мы постоянно сталкиваемся с этим, быстрый и грязный код, чтобы что-то сделать, но что происходит, мы на самом деле в конечном итоге работаем медленнее, ошибок больше и мы должны вернуться и исправить их, что на самом деле занимает гораздо больше времени, чем если бы мы медленно корректировали написанный чистый код.
«Действительно, соотношение времени, затрачиваемого на чтение и на запись, намного превышает 10: 1. Мы постоянно читаем старый код в рамках усилий по написанию нового кода. … [Следовательно,] облегчение чтения облегчает писать.
- Роберт С. Мартин, Чистый код
На самом деле люди проводят большую часть своего времени, прокручивая файл вверх и вниз в поисках того, что следует исправить. Фактическое время, которое мы тратим на набор текста, намного меньше, чем время, которое мы тратим на то, чтобы просто осматриваться, поэтому, если мы потратим время на то, чтобы сделать наш код легким для чтения, мы упростим его написание. Это основное объяснение того, почему мы должны держать наш код в чистоте, и вот пять минимальных правил, чтобы это произошло.
- Используйте значимые имена.
Хорошие имена должны отвечать на все важные вопросы, быть точными и исчерпывающими, раскрывать намерения и следовать соглашениям.
Имя переменной, функции или класса должно ответить на все важные вопросы. Он должен рассказать вам, почему он существует, для чего он нужен и как он используется.
Вы должны назвать переменную с той же осторожностью, с которой вы называете первенца.
- Роберт С. Мартин, Чистый код
2. Прокомментируйте код, если это действительно необходимо.
Код должен говорить сам за себя, когда это возможно. При обширном комментировании вам теперь необходимо поддерживать комментарии, а также код. Причина, по которой это имеет значение, заключается в том, что неправильные комментарии могут сбить будущего разработчика с неверного пути. Выразительный код требует меньше комментариев и является более чистым, поэтому прокомментируйте свой код, если вы не можете сделать это в коде, например, когда вам нужно объяснить поведение стороннего API.
3. Оставьте свой код лучше, чем вы его нашли.
Вы должны не только писать чистый код, но и выделять несколько минут на то, чтобы убрать мусор, когда вы его найдете. Следование этой мантре означает, что код со временем может стать чище и чище.
4. Следуйте принципу единой ответственности.
Чистый фрагмент кода делает одно, он делает это хорошо и делает только это. То, что вы можете, не означает, что вы должны это делать. Если вы передаете четыре или пять аргументов функции, которая, вероятно, выполняет более одного действия, или если вы создаете матрицу возможных результатов, которая может быть довольно большой и ее трудно отлаживать.
5. Напишите тесты.
Существует много типов тестов, но я говорю о двух из них: первый называется интеграционным тестом, который проверяет, как пользователь будет воспринимать ваш код, а второй - модульным тестом, который проверяет функциональность отдельных частей кода. Если у вас есть тесты, вы не боитесь вносить изменения в код! Без тестов любое изменение - возможная ошибка.
Надеюсь, каждый из нас будет следовать этим пяти минимальным правилам, чтобы облегчить себе жизнь :)
