Автор оригинала: Kevin E. Nourian.
Скачайте чит-лист здесь (Direct PDF скачать):
Вы когда-нибудь спрашивали себя, «Что значит быть профессионалом?»
Эта статья заключается в том, чтобы быть профессиональным разработчиком программного обеспечения. Он основан на книге, чистый код Роберта С. Мартина. Все цитаты из этой книги.
Читая эту статью, вы узнаете, что значит быть профессионалом, какой чистый код есть, и почему вы должны написать чистый код. Вы также будете изучать основные рекомендации о том, как написать Cleaner Code.
Кто профессионал?
«Написание чистого кода – это то, что вы должны сделать, чтобы позвонить себе профессионалом».
Несколько лет назад я нанял уборку. Она была настоящим профессионалом. Она обратила внимание на каждую деталь ее работы; Она гордилась в этом. Иногда она прошла время, когда она ходила домой, чтобы полностью закончить свою работу.
” Марк истинного профессионала – это внимание к деталям ».
Быть профессионалом не имеет ничего общего с работой и все, что связано с отношением к работе. В отличие от моей профессиональной уборки, как учитель в моей предыдущей жизни, я работал с некоторыми учителями, которые не были профессионалами. Они не ставили много усилий, чтобы создать красивые уроки. Они не обращали внимания на то, кто был сосредоточен в своем классе, который учился, и у кого были трудности. Их работа была работой, а не профессией.
” Мы честны о состоянии нашего кода, потому что код никогда не бывает совершенным ».
Профессионал обращает внимание на детали, которые кажутся маленькими, если вы посмотрите на них сами по себе, но накопление этих деталей приносит существенную разницу в качестве работы. На мой взгляд, это внимание к деталям – это то, что отделяет профессионал от заработной платы заработной платы. Заработная плата делает работу. Профессионал делает работу с осторожностью, внимание к деталям и знаниям, что всегда есть комната для улучшения.
Что такое чистый код?
” Чистый код – код, который читается как хорошо написанная проза. “
Чистый код – приятно читать. Как хорошая книга, ваш код должен быть понятен. Все части этого должны иметь смысл. Должен быть история для этого, которая понятана. Работа – это не только для записи кода, который работает, но и для записи кода, который можно прочитать и понятно с легкостью и с удовольствием.
«Получение программного обеспечения для работы и изготовление программного обеспечения чистые – две очень разные виды деятельности. Слишком много из нас думают, что мы сделаем, как только программа работает. Мы не можем перейти на другую обеспокоенность организации и чистоты. Мы переходим к следующей проблеме, а не вернусь ».
Как разработчик, у нас есть две очень разные работы: создавая программное обеспечение и изготовление программного обеспечения. Наша работа не закончена, как только наш код работает. Это было бы похоже, что работа ресторанного шеф-повара закончена, когда еда приготовлена. Это не закончено. Теперь он должен взять еду из горшка, красиво организовать его на тарелку и добавить детали, чтобы сделать еду, обращаясь к клиенту.
” Мы должны рассматривать наш код как красивая артикуляция благородных усилий дизайна – дизайна как процесс, а не статическую конечную точку ».
Как только программное обеспечение работает, нам нужно его очистить. Нам нужно подготовить его для читателя. Это должно быть организовано и ясно. Он должен читать как красивый роман, все кусочки вместе в нужном месте, в нужное время. Писатель романа тратит большую часть своего переписывания времени. Код чистки означает перезаписывать свой код, чтобы сделать его лучше.
Почему мы должны написать чистый код?
«В программном обеспечении, 80% или более того, что мы делаем, это обслуживание».
Фото Clément Hélardot.
Большинство из того, что мы делаем, как разработчики, поддерживают код, который у нас есть или кто-то еще уже написал. Создание вашего кода легко понять, важно для того, чтобы ваш код был легко поддерживать. Вот почему запись чистого кода настолько важен. Другие разработчики или вы, сами, должны поддерживать его. Чтобы сохранить его, вы должны понять это. Если ваш код трудно понять, будет трудно поддерживать.
Как написать чистый код
«Вы читаете эту книгу по двум причинам. Во-первых, вы программист. Во-вторых, вы хотите быть лучшим программистом.
Вот некоторые правила, чтобы иметь в виду, во время написания, а также, особенно, переписывая ваш код для его очистки.
Правила о функциях
«Первое правило функций заключается в том, что они должны быть маленькими. Второе правило функций заключается в том, что они должны быть меньше, чем это ».
Каждая функция является частью истории, которую ваш код пытается сказать. Напишите небольшие функции, которые имеют только одну работу. Это облегчит ваш код проще понять, а также легче расширить. Разбивайте большую функцию на более мелкие функции.
«Функции должны делать одно. Они должны это делать хорошо. Они должны сделать это только “.
Правила о классах
«Система со многими небольшими классами не имеет больше движущихся частей, чем система с несколькими крупными классами. Вопрос в том, хотите ли вы, чтобы ваши инструменты были организованы на панели инструментов со многими небольшими ящиками, каждый из которых содержит четко определенные и хорошо помеченные компоненты? Или вы хотите несколько ящиков, которые вы просто бросаете все?
Как и функции, ваша программа должна быть изготовлена из небольших классов, каждая только с одной ответственностью. Если вам трудно выяснить имя для класса, это может быть потому, что у класса имеет более одной ответственности. Сломай.
«Первое правило классов состоит в том, что они должны быть маленькими. Второе правило классов состоит в том, что они должны быть меньше, чем это ».
Правила именования
” Выбирая хорошие имена, требуют времени, но экономит больше, чем нужно. “
Нахождение хороших имен для ваших переменных, функций и классов могут иметь большое значение для того, чтобы сделать ваш код читабели и понятным. Если выбранное вами имя требует использования комментариев, чтобы объяснить его, выберите лучшее имя.
Переменные имена
” Вы должны назвать переменную, используя то же самое уход, с которой вы называете своего первого ребенка ».
Переменные имена должны быть описательными. Читатель должен точно понимать, какая переменная, просто по его названию. Длина имени не имеет значения. Ясность имени – это то, что имеет значение. Вот примеры хороших имен переменной:
- allaped_time_in_days.
- Secons_since_creation.
- number_of_tasks.
Имена функций
Имя функции должно объяснить, что делает функция. Выберите имена для функций в формате глагола, потому что функции что-то делают. Глаголы показывают действие. Вот примеры хороших функций имен:
- print_game_board.
- email_stock_message.
- display_search_results.
Названия классов
Как и функции, имя класса должно описывать свою ответственность. Классы не определяют действия. Таким образом, названия классов должны быть в формате существительного. Мы используем существительные, чтобы обратиться к объектам, людям, животным или местам. Вот примеры имен хороших классов:
- Покупатель
- Счет
- Транспортное средство
Правила форматирования
«Чистый код всегда выглядит так, будто он был написан тем, кто заботится».
Фото Дэниальный игдери
Держите читателя в виду при форматировании вашего кода. Читает ваш код легко на глазу? Помогает ли форматирование расскажет историю вашего кода? Подумайте о газетной статье. Введите читателю от самой важной части вашего кода до наименее важных. Вот несколько идей форматирования непосредственно из книги:
- ” Используйте белое пространство для разделения различных аспектов вашего кода.
- «Наиболее важные функции должны прийти на первом месте».
- «Линии кода, которые тесно связаны, должны быть ближе друг к другу».
- ” Переменные должны быть объявлены как можно ближе к их использованию.
- «Если одна функция вызывает другую, они должны быть рядом. Вызывающий должен быть выше Callee. “
Одно правило о написании комментариев
” Единственный действительно хороший комментарий – это комментарий, который вы нашли, чтобы не написать ».
Поместите все усилия, чтобы сделать ваш код понятным без комментариев. Заставить свой код говорить. Иногда все, что вам нужно сделать, это выбирать лучшие имена. Иногда вы должны переделать ваши функции или переставить, где они появляются в вашем коде. Сделать все, что вы можете не написать один комментарий.
Малые вещи считаются
«Что эти действия просты, не значит, что они упрощены, и это вряд ли означает, что они легко».
Фото АГê Баррос
Вы не станете экспертом в написании чистого кода, прочитав статью или книгу, но со временем, если вы будете посвящены этому, вы получите лучше. Результатом ваших усилий будет продукты, которые вы можете гордиться – продукты, другие оценят.
«Обучение писать чистый код – это тяжелая работа. Вы должны потеть над этим. Вы должны попрактиковаться, и посмотрите, что вы не можете потерпеть неудачу. Вы должны смотреть, как другие терпят неудачу.
Оригинал: “https://blog.finxter.com/writing-clean-code-being-a-professional/”