5 вещей, которые помогут улучшить ваш код

1
990
views

Перевод статьи «5 Things You Can Do To Write Better Code».

Как обеспечить качество кода

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

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

Планируйте его

Порой меня огорчает, что об этом все еще следует упоминать, но по многим причинам планирование часто пропускается. Вы удивитесь, узнав, сколько проектов передаются разработчикам всего лишь с несколькими скупыми указаниями насчет того, что «оно» должно делать. Люди, связанные с менеджментом проектов, проведут встречи, на которых расскажут, что им нужно, – и это все, на что можно рассчитывать.

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

Под планированием я подразумеваю в буквальном смысле сесть и подумать над потенциальным масштабом этой вещи. Насколько велик этот проект? Как много времени, по вашему мнению, понадобится на тестирование и отладку? Есть ли какой-то функционал, который, как вы считаете, заказчику понадобится или упростит использование приложения/сайта? Если вы потратите немного времени на планирование подобных вещей, это не убережет вас от всех возможных катастроф, но поможет избежать значительной их части.

Подумайте о том, как реальный человек будет пользоваться этой разработкой

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

Если вы тестируете сайт в вашей локальной среде и замечаете, что вам нужно сделать нечто хитрое, чтобы кнопка заработала, – исправьте это сразу же. Люди, которые окажутся конечными пользователями, будут вам за это благодарны. Плюс, это поможет подумать о потенциальных багах и выявить существующие.

Подумав обо всех сумасшедших и наименее вероятных вещах, которые пользователь может сделать, и написав код с учетом этих вещей, вы сэкономите много времени на отладке. Да, на предварительную работу уйдет больше времени, но это хорошо скажется на вашей карьере. Только от вас зависит, станете ли вы известны как человек, пишущий устойчивый к багам код.

Опуститесь на уровень ниже

Опуститесь на уровень ниже

Этому я научился недавно, и это изменило мое отношение к своему коду. Речь идет о фреймворках. Иногда уровень абстракции, который они используют, заходит слишком далеко и вы «теряете нить» того, что на самом деле пишете. Примером может послужить jQuery.

Сколько раз вы использовали $ для переменных? Вы помните, что это означает? Опуститесь на уровень ниже jQuery и вы получите чистый JavaScript. Прокопав сквозь него, вы найдете, что такое $.

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

Следите за ясностью кода

Весь код, который вы пишете, должен служить какой-то цели. Если в вашем коде есть что-то непонятное даже вам, то необходимо найти способ прояснить это. Используйте хорошие имена переменных и файлов. Придерживайтесь определенного соглашения об именах. Это базовые вещи, которые легко проглядеть в горячке спринта.

Последовательность очень облегчит отладку и обновление вашего кода, потому что благодаря ей вы будете точно знать, что есть что. Никому не придется теряться в догадках, что вы пытались сделать, написав какой-то участок кода, потому что это будет ясно, как день.

Однако важно найти баланс. Если вы закопаетесь в мельчайших деталях, это не улучшит ваш код. Когда у вас мало времени, а IDE каким-то странным образом форматирует ваши файлы, но код при этом все равно работает, – разберитесь с этой проблемой позже. Это просто куча пробелов, делающих файл уродливым.

Код должен быть понятным

Документация

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

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

Все это звучит хорошо, верно? Вы можете поинтересоваться, где же взять время на все это, ведь вам и сам код нужно писать. Но позвольте мне открыть вам один секрет. Время можно выкроить из отведенного на «исследования». Вы знаете, о чем я говорю. Это может потребовать всего 10 минут. Но посвящение времени любому из этих пунктов поможет вам больше, чем вы думаете.



1 КОММЕНТАРИЙ

  1. Просто удивительно, насколько шустро продвигаются некоторые проекты благодаря пропуску некоторых важных этапов, например, планирования!

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

ОСТАВЬТЕ ОТВЕТ

Please enter your comment!
Please enter your name here