Как разработчик, давайте предположим, что вы только что получили новую работу, и вам трудно освоиться и начать работать над кодовой базой вашей новой команды. Например, вы запускаете разработку своего приложения с помощью одного из этих шаблонов приложений. В этой статье мы обсудим некоторые приемы, которые помогут вам быстрее ознакомиться с новой кодовой базой.
Эти советы и рекомендации являются итогом интенсивных исследований и консультаций с некоторыми отраслевыми разработчиками. Их также вдохновляет моя новая работа в Instamobile. Здесь нет никакой магии, только практические и эффективные шаги, которые помогут вам как можно быстрее ознакомиться с новой кодовой базой.
Эта статья также поможет вам как разработчику поддерживать нормальную кодовую базу для следующего разработчика, который возьмет на себя вашу хорошую работу. Давайте прыгнем прямо в
Запустите приложение от имени конечного пользователя
Вы должны запустить живое приложение и посмотреть на функции приложения, вы должны просмотреть приложение в поисках возможных модулей, на которые можно разделить код. Такими модулями могут быть онбординг, чат, домашний модуль и так далее.
Для разработчиков внешнего интерфейса вам следует обратить внимание на меню, нижнюю навигацию, ящики или любые виджеты, которые объединяют все приложение в единое целое.
Иногда вы будете работать над одним модулем за раз, поэтому ваше внимание должно быть сосредоточено на этом одном модуле, и вы можете мысленно разбить его на подмодули.
Модули приложения
Глядя на изображение выше, я могу сразу определить некоторые из основных модулей всего приложения, и я знаю, на какие модули приложения следует обращать внимание, когда я погружаюсь в кодовую базу и начинаю работать над улучшениями.
Погрузитесь в документацию
Теперь, когда вы мысленно разделили приложение на отдельные модули, вам нужно погрузиться в код и поискать любую форму документации, которая существовала ранее. Я лично делю документацию на документацию низкого уровня и документацию высокого уровня.
Документация высокого уровня будет относиться к документации требований, архитектурному проекту и технической документации.
Для низкоуровневой документации вам следует обратить внимание на некоторые соглашения об именах, комментарии и расположение папок.
Расположение папок
На приведенном выше изображении показано типичное самодокументированное расположение папок и уже указано, где найти код для экранов, менеджеров состояний, навигации, основных компонентов приложения и даже общих стилей приложения.
Изучайте код и задавайте вопросы
Цель здесь не в том, чтобы донимать текущую команду вопросами. Вы должны сами много изучать кодовую базу, учитывая, что есть много информации о кодовой базе и системе, над которой вы будете работать.
Важность учебы невозможно переоценить. Небольшое количество исследований может принести огромную пользу и помочь вам проявить инициативу в отношении новых проектных идей, рефакторинга и улучшений кодовой базы.
Рекомендуется задавать только вопросы, имеющие решающее значение, чтобы не показаться занозой в заднице вашим новым коллегам/команде. У меня есть коллега, который настаивает на том, что в программировании нет слишком глупых вопросов, и я полностью согласен с ним в этом.
Отличным качеством разработчика является не только задавать вопросы, но и задавать вопросы правильно, то есть формулировать вопрос таким образом, чтобы получить полезный ответ.
Переписать
В экстремальных условиях вы можете захотеть переписать часть или всю кодовую базу, над которой вы будете работать. Это должно быть в тех случаях, когда кодовая база вызовет дополнительные проблемы как у вас, так и у разработчиков, которые будут работать с одной и той же кодовой базой в будущем.
Это может стоить вашей новой компании много времени и усилий, и это должно быть последним средством. Поверьте мне, вы должны очень долго обсуждать со своим руководителем плюсы и минусы переписывания некоторых или всех модулей кодовой базы, за которую вы отвечаете.
Заключение
Эти приемы можно применять к одному модулю за раз, а затем использовать полученные приемы и применять к другим модулям кодовой базы.
Для вас, как для разработчика, также чрезвычайно важно поддерживать как можно более безупречную кодовую базу, чтобы не превращать жизнь других разработчиков в кошмар.
Начало работы над новой кодовой базой может быть очень сложным и трудным для тех, кто устраивается в новую команду и изучает новую кодовую базу, но я надеюсь, что эта статья поможет вам сделать процесс ознакомления с новой кодовой базой приятным.
В Instamobile мы создаем Шаблоны приложений iOS, Шаблоны приложений Flutter, Шаблоны приложений Android и Шаблоны React Native, чтобы помочь разработчикам и предпринимателям быстрее запускать свои мобильные приложения.