Советы по наименованию и стилю кода для сценариев C# в Unity

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

Ниже перечислены несколько известных соглашений по именованию и написанию:

Верблюжий регистр

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

Как правило, локальные переменные и параметры методов пишутся в верблюжьем регистре. Например:

examplePlayerController
maxHealthPoints
endOfFile

Паскаль регистр

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

ExamplePlayerController
MaxHealthPoints
КонецФайла

Змеиный регистр

В этом случае пробелы между словами заменяются символом подчеркивания. Например:

example_player_controller
max_health_points
end_of_file

Кебабный стиль

Здесь пробелы между словами заменяются дефисами. Слова затем появляются на своеобразном «шпажке» из дефисов. Например:

example-player-controller
Max-health-points
конец-файла

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

Венгерская нотация

Имя переменной или функции часто указывает на ее намерение или тип. Например:

int iCounter
string strPlayerName

Венгерская нотация — это старая традиция и не часто используется в разработке Unity.

Рассмотрите эти правила для ваших переменных и полей:

• Используйте существительные для имен переменных: Имена переменных должны быть ясными и описательными, так как они представляют собой конкретную вещь или состояние. Используйте существительное при их именовании, за исключением случаев, когда переменная типа bool (см. ниже).
• Добавьте к булевым переменным префикс с глаголом: Эти переменные указывают на истинное или ложное значение. Часто они являются ответом на вопрос, такой как: Игрок бежит? Игра окончена?
• Представьте их с помощью глагола, чтобы сделать их значение более очевидным. Часто это сочетается с описанием или условием, например, isDead, isWalking, hasDamageMultiplier и т.д.
• Используйте значимые имена. Не сокращайте (если это не математика): Имена ваших переменных будут раскрывать их намерение. Выбирайте имена, которые легко произносить и искать.
• Хотя переменные с одной буквой подходят для циклов и математических выражений, не сокращайте в других ситуациях. Ясность важнее, чем любое время, сэкономленное на опущении нескольких гласных.
• Для быстрого прототипирования вы можете временно использовать короткие "мусорные" имена, а затем переработать их на более значимые имена позже.
• Используйте PascalCase для публичных полей и camelCase для приватных переменных: В качестве альтернативы публичным полям используйте свойства с публичным "геттером" (см. предыдущие и последующие разделы).
• Избегайте слишком многих префиксов или специального кодирования: Вы можете добавлять префикс к приватным переменным-членам с помощью подчеркивания (_), чтобы отличать их от локальных переменных.
• В качестве альтернативы используйте ключевое слово this, чтобы различать переменные-члены и локальные переменные в контексте и пропустить префикс. Публичные поля и свойства, как правило, не имеют префиксов.
• Некоторые руководства по стилю используют префиксы для приватных переменных-членов (m_), констант (k_) или статических переменных (s_), чтобы имя могло раскрывать больше о переменной с первого взгляда.
• Многие разработчики избегают этого и полагаются на редактор вместо этого. Однако не все IDE поддерживают подсветку и цветовую кодировку, и некоторые инструменты вообще не могут показать богатый контекст. Учтите это, принимая решение о том, как (или если) вы будете применять префиксы вместе как команда.
• Последовательно указывайте (или опускайте) модификаторы уровня доступа: Если вы опустите модификатор доступа, компилятор предположит, что уровень доступа должен быть приватным. Это работает хорошо, но будьте последовательны в том, как вы опускаете модификатор доступа по умолчанию.
• Помните, что вам нужно будет использовать protected, если вы хотите это в подклассе позже.

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

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

Примечание: Перечисления с битовыми значениями, помеченные атрибутом System.FlagsAttribute, являются исключением из этого правила. Вы обычно делаете их во множественном числе, так как они представляют более одного типа.

Следуйте этим стандартным правилам при именовании ваших классов и интерфейсов:

Используйте существительные в PascalCase для имен классов: Это поможет вам организовать ваши классы.

Если у вас есть MonoBehaviour в файле, имя исходного файла должно совпадать: В файле могут быть другие внутренние классы, но только один MonoBehaviour должен существовать на файл.

Префиксируйте имена интерфейсов заглавной буквой “I”: Следуйте этому с прилагательным, которое описывает функциональность.

В C# каждая выполняемая инструкция выполняется в контексте метода.

Методы выполняют действия, поэтому применяйте эти правила для их именования соответственно:

Начните имя с глагола: Добавьте контекст, если это необходимо (например, ПолучитьНаправление, НайтиЦель и т.д.)

Используйте camel case для параметров: Форматируйте параметры, передаваемые в метод, как локальные переменные.

Методы, возвращающие bool, должны задавать вопросы: Подобно самим булевым переменным, префиксируйте методы глаголом, если они возвращают условие истинности или ложности. Это формулирует их в виде вопроса (например, ИграЗавершена, НачалсяХод).

Примечание: Термины "функция" и "метод" часто используются взаимозаменяемо в разработке Unity. Однако, поскольку вы не можете написать функцию, не включив ее в класс в C#, "метод" является правильным термином.

События в C# реализуют шаблон наблюдателя. Этот шаблон проектирования программного обеспечения определяет отношения, в которых один объект, субъект (или издатель), может уведомлять список зависимых объектов, называемых наблюдателями (или подписчиками). Таким образом, субъект может транслировать изменения состояния своим наблюдателям, не связывая тесно вовлеченные объекты.

Существуют несколько схем именования для событий и их связанных методов в субъекте и наблюдателях. Попробуйте практики в следующих разделах.

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

Используйте настоящее или прошедшее причастие, чтобы указать состояние событий до или после. Например, укажите "ОткрытиеДвери" для события перед открытием двери и "ДверьОткрыта" для события после.

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

Вы можете передать до 16 входных параметров разных типов с возвращаемым типом void. Использование предопределенного делегата экономит код.

Примечание: Вы также можете использовать делегаты EventHandler или EventHandler. Согласуйте в команде, как каждый должен реализовывать события.

Префикс метода вызова события (в субъекте) должен быть «On». Субъект, который вызывает событие, обычно делает это из метода с префиксом «On» (например, «OnOpeningDoor» или «OnDoorOpened»).

Префикс метода обработки события (в наблюдателе) должен содержать имя субъекта и символ подчеркивания (_). Если субъект называется «GameEvents», ваши наблюдатели могут иметь метод под названием «GameEvents_OpeningDoor» или «GameEvents_DoorOpened».

Решите, какую схему именования использовать вашей команде, и реализуйте эти правила в вашем руководстве по стилю.

Примечание: Этот «метод обработки событий» не следует путать с делегатом EventHandler.

Создавайте пользовательские EventArgs только в случае необходимости. Если вам нужно передать пользовательские данные в ваше событие, создайте новый тип EventArgs, унаследованный от System.EventArgs или от пользовательской структуры.

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

При применении пространств имен:

Используйте PascalCase без специальных символов или подчеркиваний.

Добавьте директиву using в верхней части файла, чтобы избежать повторного ввода префикса пространства имен.

Создавайте также подпространства имен. Используйте оператор точки (.) для разделения уровней имен, позволяя вам организовать ваши скрипты в иерархические категории. Например, вы можете создать «MyApplication.GameFlow», «MyApplication.AI», «MyApplication.UI» и так далее, чтобы хранить различные логические компоненты вашей игры.

В коде эти классы называются Враг.Контроллер1 и Враг.Контроллер2, соответственно. Добавьте строку using, чтобы избежать повторного ввода префикса (например, using Враг;).

Когда компилятор находит имена классов Контроллер1 и Контроллер2, он понимает, что вы имеете в виду Враг.Контроллер1 и Враг.Контроллер2.

Если скрипт должен ссылаться на классы с одинаковыми именами из разных пространств имен, используйте префикс для их различия. Например, если у вас есть классы Контроллер1 и Контроллер2 в пространстве имен Игрок, вы можете записать Игрок.Контроллер1 и Игрок.Контроллер2, чтобы избежать конфликтов. В противном случае компилятор сообщит об ошибке.