Правила оформления (нейминга) данных
Table of contents
1. Использование английского языка в неймингах
Всем названиям объектов и параметров в вашем проекте рекомендуется давать имена на английском языке. Зачем:
- Помогает обеспечить универсальность и понятность для международной аудитории.
- Облегчает перевод конфигов в код, так как английский является стандартом в сфере программирования и разработки.
Пример:
- Не «Магазины игры», а «store».
2. Повсеместное использование строчных букв (за редкими исключениями)
Для именования объектов и параметров желательно использовать строчные буквы. Это улучшает читаемость и упрощает работу с данными.
Пример:
- Не «Billing», а «billing».
3. Использование капса в неймах локализации
В локализации принято писать названия текстовых объектов заглавными буквами. Это помогает выделять строки и упрощает их поиск в коде и базах данных. Например, вместо «Best value!» пишите «BEST_VALUE». Так текстовые элементы и их переводы будут более различимы.
Пример:
- Не «Best value», а «BEST_VALUE».
4. Использование подчеркивания (_) для разделения слов
Если имя объекта или параметра состоит из нескольких слов, для их разделения используйте символ подчеркивания (_). Это улучшает читаемость и позволяет избежать ошибок при интерпретации названий.
Пример:
- Не «skin id», а «skin_id».
5. Лаконичность и использование геймдев лексикона
Названия объектов должны быть максимально лаконичными и соответствовать принятой лексике в игровой индустрии. Не следует использовать художественные или избыточные описания. Это помогает избежать путаницы и облегчает понимание данных как для разработчиков, так и для игроков.
Пример:
- Не «Всплывающее предложение», а «offer».
6. Глаголы в названиях элементов, проверяющих состояние
Когда создаете переменные или функции для проверки состояния объекта (например, жив ли персонаж, завершено ли строительство здания), предпочтительнее использовать глаголы в названии. Это делает конфигурацию (или код) более читабельной и понятной.
Пример:
- Не «alive», а «is_alive».
Дополнительные рекомендации
- Консистентность: придерживайтесь единых правил нейминга на протяжении всего проекта.
- Понятность: имена должны быть интуитивно понятны и отражать суть объекта или параметра.
- Структурированность: используйте префиксы и суффиксы для обозначения типов объектов, если это необходимо (например, «btn» для кнопок — «btn_start»).
Следование этим правилам поможет создать четкую и структурированную систему именования, которая облегчит разработку, поддержку и локализацию ваших игровых проектов.