Connect with us

Разработка

Григорий Петров: Стандарт оформления кода: и не стандарт, и не оформления, и не только кода

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

Григорий Петров

Опубликовано

/

     
     

Во многих компаниях первый рабочий день программиста начинается с изучения “стандарта оформления кода”, он же “стандарт кодирования”, “coding standard” или “coding convention”. Обычно это монструозный многостраничный документ, в котором подробно описано, как именно принято писать код в компании. Очень подробно.

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

Зачем нужна эта штука

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

shvedskie_shahmatu

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

Со временем разработчики поняли, что сложность кроется не только в том, как код выглядит, но и в том, что он делает. Стандарты кодирования эволюционировали и стали включать в себя не только правила оформления, но и правила написания кода. Современный стандарт кодирования содержит весь накопленный командой опыт о том, как надо и как не надо писать код. Кроме вопросов оформления, он также включает в себя список лучших и худших практик разработки, принятые в команде стратегии для работы с типовыми задачами, список используемых фреймворков, библиотек и многое другое. Особенно в этом плане отличились крупные системные интеграторы и компании по заказной разработке, стандарты кодирования в которых зачастую содержат сотни страниц подробнейших инструкций, фиксирующих вообще все, включая “единственно правильную” версию Java.

Кнут, пряник и учебник под одной обложкой

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

scheme_lisp_SICP_Japan_edition

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

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

Советы по созданию стандарта кодирования

Каждый разработчик хочет переписать все с нуля, и это естественно. Хороший стандарт кодирования всегда начинается со вступления, где вы рассказываете про сложность, про борьбу с ней, и о том, чем полезен стандарт кодирования. Если этого не сделать, то есть риск быть непонятным, и новый разработчик отнесется к вашим знаниям как к “блажи потерявшего связь с реальностью тим лида”. Будет очень обидно, да?

Интегрируйте стандарт кодирования в “onboarding” новых разработчиков. Внимательно относитесь к их вопросам, так как они смотрят на ваш стандарт свежим, “незамыленным” взглядом. Каждый новый разработчик, читающий ваш стандарт кодирования – это возможность что-то улучшить, переписать более понятным языком, внести ответы на часто задаваемые вопросы.

Разбейте стандарт кодирования на обязательные для исполнения правила; рекомендованные, но не обязательные; и просто рекомендованные. Слишком большой объем обязательных для исполнения правил в клочья разрывает кошелек Миллера новым разработчикам, понижает им удовольствие от работы и способствует возникновению напряженности в команде. Обратная сторона медали – если все правила будут только “рекомендациями”, то многие разработчики будут игнорировать их из-за лени. Постарайтесь подобрать баланс между обязательными и необязательными правилами так, чтобы оставить разработчикам свободу творчества, но при этом дать им возможность понимать код друг друга и не изобретать слишком много велосипедов.

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

Напоследок скажу традиционное. Стандарт кодирования, как и многие другие описанные мною практики – это всего лишь инструмент для решения определенных задач. Только понимание этих задач, а также сильных и слабых сторон используемых инструментов, поможет вам сделать процесс разработки чуть более стабильным и предсказуемым. А там, глядишь, и релизы начнут вовремя случаться.

Комментарии
Если вы нашли опечатку - выделите ее и нажмите Ctrl + Enter! Для связи с нами вы можете использовать info@apptractor.ru.
Advertisement
Click to comment

You must be logged in to post a comment Login

Leave a Reply

Медиа

Podlodka #89: Перфоманс

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

AppTractor

Опубликовано

/

Автор:

Podlodka

Денис Мишунов объяснил, почему производительность важна, как ее воспринимает мозг человека и показал варианты решения проблем этого восприятия. Александр Тоболь провел краткий экскурс в то, как работают различные сетевые протоколы и их клиентские реализации и открыл целую область для оптимизаций. Артур Василов и Николай Лихогруд копнули в оптимизацию перфоманса клиентского кода Android и iOS приложений соответственно. Короче говоря, если вы не знаете, как и зачем сделать свой продукт быстрым – этот выпуск однозначно для вас!

Комментарии
Продолжить чтение

Новости

Интересные материалы: 13.12

У нас в конце недели история приложения учета времени, проводимого в соц.сетях, митапы Туту.ру и тренды дизайна на следующий год.

AppTractor

Опубликовано

/

Автор:

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

Комментарии
Продолжить чтение

SDK

Epic выпустит SDK для кроссплатформенных игр

Epic Games в следующем году выпустит SDK для организации кроссплатформенных игр.

AppTractor

Опубликовано

/

Автор:

Новый Online Services SDK позволит регистрироваться в играх через разные социальные сети и платформы, заводить списки друзей, показывать свое присутствие, вести профиль и т.п. вещи, будет также облачное хранилище для сохранения игр, достижения и награды, голосовые коммуникации, подбор игроков для мультиплеера.

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

Предполагается, что все это будет бесшовно работать на PC, Mac, iOS, Android, PlayStation, Xbox и Switch. Предполагается, что сначала SDK выйдет для Windows – примерно во втором или третьем квартале. Остальные платформы будут подключаться по мере готовности.

SDK будет открытым, первоначально поддерживать Unreal Engine и Unity, инфраструктура – Amazon Web Services. Epic обещает полную поддержку GDPR.

 

Комментарии
Продолжить чтение

Разработка

Главные тренды мобильной разработки в 2019

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

Epom Apps

Опубликовано

/

Автор:

Количество пользователей смартфонов в 2019 году достигнет 2,5 миллиардов, а постоянно растущее число приложений в Google Play и Apple App Store делает мобильную разработку одним из самых динамичных и конкурентных секторов.

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

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

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

Эволюция машинного обучения и искусственного интеллекта

Доход приложений от внедрения искусственного интеллекта (Artificial Intelligence, AI) на мировом рынке постоянно растет и превысит 100 млн. долларов к 2025 году. Согласно исследованиям Gartner, 200 самых крупных компаний в мире активно внедряют и полагаются на данные машинного обучения.

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

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

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

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

Мгновенные приложения для Android

Идея мгновенных приложений (Instant Apps), которые Android выкатил еще в 2016, наконец набирает обороты. Благодаря этой технологии пользователи могут получить доступ к функционалу приложения, не загружая его. Для пользователей выгода очевидна: концепция “попробуй, прежде чем купить” позволит им сэкономить время на чтение отзывов, и самим попробовать фичи приложения.

Google Play планирует таким образом сэкономить память в смартфонах. Но одна из проблем заключается в том, что мгновенные приложения работают корректно с приложениями без тяжелой графики.

Тяжеловесным играм с большим функционалом может быть сложно экспериментировать с мгновенными приложениями.

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

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

Персонализация vs GDPR

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

Персонализация в 2019 не менее важна, чем приватность. Исследование Salesforce показывает, что 65% пользователей считают, что персонализация повышает их лояльность к компании. В то же время пользователи ценят конфиденциальность данных.

Это вызвало противоречия в онлайн-экосистеме: большие компании типа Google или Facebook запрашивали личную информацию, чтобы «обеспечить более качественный пользовательский опыт». Но правила GDPR теперь обязывают объяснять пользователям, какие данные и зачем собирает компания и дать им выбор – отказаться от сбора cookie, или разрешить системе узнать себя лучше.

Разработчики уверены, что GDPR не повредит персонализации, и она останется актуальным трендом 2019 года.

Появление новых способов монетизации

Объем рынка мобильной рекламы оценивается в 250 миллиардов долларов, поэтому все больше разработчиков стремятся к тому, чтобы монетизировать приложения рекламой. Но даже применяя все известные стратегии монетизации, попасть в 5% самых высокодоходных приложений нереально. Поэтому разработчики используют нетрадиционные способы монетизации приложений.

Монетизация пользовательских данных начала развиваться пару лет назад и сегодня является одним из быстрорастущих трендов. Монетизация данных — это процесс сбора и передачи неперсональных данных пользователей посреднику. Для приложений с DAU от 60 000 пользователей этот вариант – идеальный пассивный заработок.
Монетизация данных полностью соответствует правилам GDPR и Google Play Policy, но требует явного согласия пользователей перед началом процесса сбора данных.

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

UX: От сложного к простому

Упрощенный UX помогает пользователям быстро ориентироваться в приложении и находить то, что они искали. Дизайн мобильных приложений должен предсказывать поведение пользователей, быть минималистичным, и учитывать Swiping-жесты, чтобы обеспечивать целостный опыт для пользователей приложений. А с развитием Google Pay и Apple Pay,  желательно добавить возможность оплаты виртуальной картой.

Вспомните нашумевший редизайн Snapchat: некоторое время назад они изменили свой узнаваемый интерфейс приложения и отвели больше места пользовательскому контенту и рекламе. Реакция пользователей на новые функции Snapchat была ужасной: они утверждали, что новый Snapchat более сложный в пользовании, а затем подписали петицию, чтобы вернуть старый-добрый дизайн. В конце концов, команде из Snapchat пришлось вернуть все, как было. Snapchat сделал шаг назад с точки зрения дизайна, но смог удержать лояльность пользователей.

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

Усиленная защита мобильных приложений

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

В 2019 ожидается усиление безопасности Android и iOS-приложений, но увы, низкокачественных приложений в обоих магазинах приложений все еще много.

Не надейтесь, что пронесет —проверьте приложение на предмет пробелов в безопасности. Список удобных инструментов проверки приложений включает ZAP, Micro Focus, Kiuwan и многие другие.

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

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

Комментарии
Продолжить чтение

Реклама

Наша рассылка

Нажимая на кнопку "Подписаться" вы даете согласие на обработку персональных данных.

Вакансии

Популярное

X
X

Спасибо!

Теперь редакторы в курсе.