Следуйте руководству по стилю

Следуйте руководству по стилю

В информатике есть только две по‐настоящему сложные задачи: инвалидация кеша и именование сущностей. — Фил Карлтон, инженер-программист

Руководство по стилю для вас и вашей команды В этом руководстве рассматриваются наиболее распространенные соглашения, с которыми вы столкнетесь при разработке на Unity. В основном это подмножество рекомендаций Microsoft Framework Design Guidelines, содержащих гораздо больше правил, чем представлено здесь. Это рекомендации, а не незыблемые правила. Адаптируйте их к предпочтениям своей команды. Выберите стиль, который устраивает всех, и следите за его соблюдением. Главное — единообразие. Если в будущем руководство по стилю потребуется изменить, несколько операций поиска и замены позволят быстро обновить всю кодовую базу.

Если ваше руководство по стилю расходится с этим документом или Microsoft Framework Design Guidelines, приоритет следует отдать собственному руководству: так команда сохранит единый стиль во всем проекте.

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

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

Если вы работаете в одиночку, поначалу это может казаться ограничением, однако в командной разработке руководство по стилю необходимо. Считайте руководство по стилю первоначальным вложением, которое окупится позднее. Единый набор стандартов сокращает время на повторное освоение правил, когда разработчик переходит в другой проект. Microsoft и Google предлагают подробные руководства-примеры, которые принято считать отраслевыми стандартами: — Соглашения Microsoft по написанию кода C# — Руководство Google по стилю C# Они служат отличной отправной точкой для разработки на Unity и предлагают решения по именованию, форматированию и комментированию кода. В Unity мы не навязываем единый стиль кода всем учебным материалам для начинающих, документации и примерам проектов. Строгое руководство может усложнить обучение новичкам, тогда как большим командам и сложным проектам нужны более жесткие правила. У человека, который только осваивает Unity и, возможно, свой первый язык программирования, совсем иные потребности, чем у инженерной организации из более чем 2000 сотрудников.

Поэтому здесь используется стиль, расширяющий Microsoft Framework Design Guidelines, где определен ряд правил, не вошедших в этот документ. Он близок к стилю наших инженерных команд и авторов документации и, на наш взгляд, подходит большинству проектов Unity: в нем прагматизм поставлен выше формальной строгости.

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