Как новичок в обширном и сложном мире разработки программного обеспечения, я начал с двух опасных заблуждений:

  • Первая заключалась в том, что кодирование было просто большой игрой покемонов. Моя единственная работа заключалась в том, чтобы «поймать» или, в данном случае, изучить все языки, а затем использовать их для написания кода.
  • Во-вторых, мой код должен был прочитать только компьютер. Ну да! Кто еще, да?

Каково же было мое удивление, когда я узнал, что существует такая вещь, как «хороший код» и что это - именно то, что я должен был написать. Более того, мой код должен быть «читабельным», чтобы коллеги и будущие сотрудники могли его понять!

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

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

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

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

В моем коде были ошибки, ошибки и ошибки, а мои методы были длиннее, чем Les Miserables (книга настолько длинная, что известна как «Кирпич»).

Если этого было недостаточно, я нашел Святой Грааль: комментарии!

«Мой код не имеет смысла». Я подумал: «Но я могу объяснить, что имею в виду, в комментариях!»

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

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

Зачем писать чистый код?

1. Это действительно экономит ваше время

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

2. Отладка станет проще

Чистый код поможет вам быстрее отлаживать. Это также позволяет вашим коллегам легко вмешаться и помочь вам, если это необходимо.

3. Это делает совместную работу более удобной.

Еще одно заблуждение о программировании состоит в том, что вы будете работать в одиночку, но на самом деле это не так. Чаще всего вы будете работать с другими людьми. Сделайте это сотрудничество максимально легким, написав красивый, чистый код, с которым они смогут легко работать.

"Помнить! Вы несете ответственность за качество своего кода! "

Во время исследования того, как очистить свой код, я несколько раз сталкивался с этой идеей, и она действительно изменила мое мышление по этой теме. Принятие личной ответственности за свой код означало, что я создавал что-то важное для меня, и я создавал это с осторожностью и вниманием.

Хорошо, теперь ты продан! Вы хотите писать чистый код, но ...

Как вообще выглядит чистый код?

1. Элегантный

Тот, кто читает ваш код, должен знать, что он делает. Для них это должно иметь смысл.

По словам Грэди Буча, «чистый код - это просто и понятно. Чистый код читается как хорошо написанная проза ».

2. Сосредоточенность

Код должен быть простым и понятным. Он должен соответствовать принципу единой ответственности (подробнее об этом ниже).

3. Легко обслуживать и менять

Добавление функций в код или изменение существующих функций должно происходить без проблем.

Теперь, когда вы знаете, почему и что, я покажу вам, как!

Существует множество книг, статей и видео по написанию чистого кода, но я собираюсь сосредоточить этот список на новичках, таких как я.

Как мы можем начать внедрять чистый код в наши программы?

1. План!

Не начинайте писать код, пока не наберете свои модели и не наметите, что хотите делать. Если вы точно знаете, чего хотите, проще написать это чисто!

2. Отступ

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

3. Имя с намерением

В идеале имена, которые вы даете своим переменным, методам и классам, должны показывать, почему они существуют и что они делают. Эти имена также должны быть легко произносимыми. Одной из распространенных практик, о которых следует помнить, является использование существительных для имен классов и глаголов для методов.

4. Принцип единой ответственности

Убедитесь, что ваши классы несут ответственность за одну часть функциональности кода.

5. Разделение проблем

Каждую ответственность / проблему в вашей программе следует выделить в отдельный раздел.

6. Упростите свои методы

Обычно ваши методы не должны быть длиннее 5 строк и иметь не более 3 аргументов. Если ваш метод становится слишком длинным, его, вероятно, можно разделить на 2 (или более) метода. Если у вас слишком много аргументов, возможно, некоторые из них следует поместить в отдельный класс.

7. СУХОЙ

Не повторяйся! Всегда проверяйте, не создавали ли вы что-то подобное. Если вы повторяете строку кода снова и снова, возможно, пришло время провести рефакторинг.

8. Не используйте комментарии как костыль

Если вы обнаружите, что используете комментарии для объяснения или даже оправдания своего кода, примите это как ключ к тому, что вам нужно очистить этот код.

9. Без жесткого кодирования

Часть написания чистого кода - это написание кода, который можно легко изменить или обновить. Жесткое кодирование - заклятый враг обновлений. Ваш код - это Готэм, а жесткое кодирование - это Джокер. Хорошая новость в том, что это делает вас Бэтменом!

10. Тест!

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

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

«Унция профилактики стоит фунта лечения». Бенджамин Франклин