Это код, который делает приложение. Это код, который ломает приложение. Хотя это работает хорошо, но ваш наставник или менеджер все еще выискивает дыры в вашем коде, вы должны принять это к сведению.
Вы не единственный программист, работающий над проектом.
Код — это гораздо больше, чем последовательность инструкций, данных машине.
Ваш код должен быть чистым и иметь возможность общаться с людьми, потому что другие программисты будут читать ваш код. Они будут работать над вашим кодом. Даже вы не сможете понять и поддерживать свой собственный код, если он ужасен.
Программисты работают под постоянным давлением приближающихся сроков. У кого есть время для написания комментариев, чтобы сделать код понятным для других программистов?
Написание читаемого и чистого кода — лучшая альтернатива использованию комментариев для описания элемента программирования, будь то переменная, константа или функция.
Кто-то мог сказать вам, что не писать комментарии — это плохая практика кодирования. Однако это не так. Просто используйте осмысленные имена для программных элементов, которые вы создаете. Просто держите свой код в чистоте.
Для машины следование грязному фрагменту кода в таблице — это просто последовательность инструкций. Тем не менее, это будет проблематично для некоторых других программистов. Этот фрагмент кода определенно поставит под сомнение ваши навыки кодирования.
Когда код чистый, любой может понять, что эта функция будет возвращать записи для даты, переданной в качестве аргумента.
Почему важно писать чистый код?
Время, потраченное на чтение кода, больше, чем время, потраченное на написание кода
Что ж, существует мнение, что программисты всегда заняты написанием кода. Реальность другая. Программисты тратят большую часть своего времени на чтение кода, отладку и выяснение того, как они могут оптимизировать код для повышения производительности разрабатываемого приложения. Как они могут уменьшить временную сложность вложенных циклов? Программист не может оптимизировать кусок кода, не понимая, что он делает. Вот почему хороший программист никогда не создает беспорядка при написании кода.
Написание кода требует времени
Общие функции создаются только один раз и используются во многих проектах. Иногда перед повторным использованием существующего фрагмента кода вносятся небольшие изменения. Это экономит время, усилия и деньги. Однако при разработке пользовательского веб-приложения, мобильного или настольного приложения практика копирования и вставки кода может привести к риску, если изменения внесены неправильно. Независимо от того, используете ли вы код повторно или пишете новый код, он требует вашего времени. Итак, сделайте его чистым. Ужасный код не только увеличит стоимость и время, но и максимизирует риск ошибок, багов и сбоев.
Написание большего количества кода увеличивает сложность и стоимость
Разработка сложных приложений с уникальными функциями и возможностями требует больше усилий по написанию кода. Размер и сложность умножают расходы, которые вам приходится нести. Написание чистого кода устраняет догадки и недоразумения, что облегчает другим программистам поддержку, повторное использование и изменение существующего кода. Это поможет контролировать сложности и затраты.
Чистый код удобен для отладки и тестирования
Пишите чистый код не только для других разработчиков, но и для отладчиков и тестировщиков. Те, кто будет проверять разрабатываемое приложение на наличие ошибок, дефектов и багов, должны иметь возможность изучить код реализации функциональных возможностей.
Учтите это:
Предположим, есть две функции, одна из которых извлекает записи сотрудников из базы данных, а другая загружает записи в формате PDF.
Когда пользователь нажимает кнопку «Загрузить PDF-отчет», приложение выдает какую-то ошибку или исключение.
Грязный код:
Отладчик или тестер просматривает код, чтобы выяснить, что не так. Обе функции принимают некоторые значения целочисленного типа. Отладчик или тестер ничего не знает об этом значении. Это номер сотрудника, идентификатор сотрудника, зарплата или идентификатор отдела?
Чистый код:
Чистый код читается. Понятно, что обе функции принимают номер сотрудника.
Таким образом, чистый код на самом деле помогает отладчикам и тестировщикам выявлять и сообщать об ошибках или любых других проблемах.
Характеристики чистого кода
Характеристики чистого кода:
• Читается.
• Он многоразовый (но не всегда).
• Он сфокусирован.
• Это можно проверить.
• Он не содержит дубликатов.
• Он минимизирует классы, функции и другие объекты.
Как писать чистый код
Писать чистоту просто.
Используйте осмысленные имена
Так же, как мы использовали в наших примерах.
• fetchEmployeeRecords
• скачатьPDFReport
• получитьRecordsByDate
• empNum
Следуйте соглашениям о кодировании
Имена закрытых и защищенных переменных начинаются с подчеркивания (_).
интервал _engineNum;
Константы всегда в верхнем регистре.
string BRAKE_TYPE="Диск";
Комментарии
Написание комментариев означает, что вы сделали что-то не так. Вы не смогли написать код, который взаимодействует. Однако комментарии иногда необходимы. Блок комментариев заголовка состоит из:
@категория
@упаковка
@автор
@версия и т. д.
Необходимы юридические комментарии, такие как заявления об авторских правах и лицензиях.
В Finepoint Design мы создаем все наши веб-сайты с чистым кодом, который легко понять любому, независимо от того, кто над ним работает. Чистый код — это форма искусства, которую могут оценить как программисты, так и разработчики.
Фото автора Émile Perron на Unsplash
