Понятные названия полей и свойств
Название переменной начинается с маленькой буквы. Если название состоит из нескольких слов, то каждое последующее слово начинается с заглавной буквы. Название должно четко отражать содержимое переменной.
В случае с булевой переменной, название должно отображать вопрос, ответ на который будет "Да" или "Нет".
___
#лр_хороший_код
Название переменной начинается с маленькой буквы. Если название состоит из нескольких слов, то каждое последующее слово начинается с заглавной буквы. Название должно четко отражать содержимое переменной.
В случае с булевой переменной, название должно отображать вопрос, ответ на который будет "Да" или "Нет".
___
#лр_хороший_код
👍3
Понятные названия методов
Название метода начинается с заглавной буквы. Если название состоит из нескольких слов, то каждое последующее слово начинается также с заглавной буквы. Название должно недвусмысленно отражать то, что происходит внутри метода.
Если метод возвращает не булевые данные, то метод начинается с ключевого слова Get.
___
#лр_хороший_код
Название метода начинается с заглавной буквы. Если название состоит из нескольких слов, то каждое последующее слово начинается также с заглавной буквы. Название должно недвусмысленно отражать то, что происходит внутри метода.
Если метод возвращает не булевые данные, то метод начинается с ключевого слова Get.
___
#лр_хороший_код
👍3
Единый стиль наименований событий (event)
Название события начинается с приставки "On". Последующие слова названия начинаются с заглавной буквы. Оканчивается название события суффиксом "Event".
Название метода, подписанного на событие, начинается с приставки "On", последующие слова названия начинаются с заглавной буквы. В отличие от названия события НЕ ОКАНЧИВАЕТСЯ суффиксом "Event".
Небольшое отличие в названиях событий и подписанных на них методов позволяет моментально отличить событие от метода, когда среда разработки (IDE), предлагает автоподстановку, при написании кода. Уменьшается вероятность совершить промах, увеличивается скорость написания кода, повышается "понятность" кода.
___
#лр_хороший_код
Название события начинается с приставки "On". Последующие слова названия начинаются с заглавной буквы. Оканчивается название события суффиксом "Event".
Название метода, подписанного на событие, начинается с приставки "On", последующие слова названия начинаются с заглавной буквы. В отличие от названия события НЕ ОКАНЧИВАЕТСЯ суффиксом "Event".
Небольшое отличие в названиях событий и подписанных на них методов позволяет моментально отличить событие от метода, когда среда разработки (IDE), предлагает автоподстановку, при написании кода. Уменьшается вероятность совершить промах, увеличивается скорость написания кода, повышается "понятность" кода.
___
#лр_хороший_код
👍2
Модификаторы доступа пишутся ВСЕГДА
В некоторых источниках (и Unity в том числе) предлагается при использовании модификатора "private" - его опускать. То есть явно указывать лишь "public" и "protected". В таком случае методы и переменные уже не выглядят унифицировано, а следовательно при беглом чтении кода создается маленький хаос в голове. Удобнее читать, когда все методы и переменные выглядят одинаково.
___
#лр_хороший_код
В некоторых источниках (и Unity в том числе) предлагается при использовании модификатора "private" - его опускать. То есть явно указывать лишь "public" и "protected". В таком случае методы и переменные уже не выглядят унифицировано, а следовательно при беглом чтении кода создается маленький хаос в голове. Удобнее читать, когда все методы и переменные выглядят одинаково.
___
#лр_хороший_код
👍3
Использовать регионы для удобства работы с кодом
Любой класс можно условно разделить на участки кода, объединённые общим свойством. Такие участки кода удобно обрамлять тегами, которые позволяют "свернуть" участок кода.
Далее представлены типичные регионы, которые я обычно выделяю в коде.
1. CONSTANTS - участок кода с объявлением констант.
2. EVENTS (1) - участок кода с объявлением событий.
3. LIFECYCLE - участок кода с нативными методами MonoBehaviour (пр. Awake(), Start(), OnEnable() и др.).
4. EVENTS (2) - участок кода, с обработкой событий, на которые подписан текущий класс.
___
#лр_хороший_код
Любой класс можно условно разделить на участки кода, объединённые общим свойством. Такие участки кода удобно обрамлять тегами, которые позволяют "свернуть" участок кода.
Далее представлены типичные регионы, которые я обычно выделяю в коде.
1. CONSTANTS - участок кода с объявлением констант.
2. EVENTS (1) - участок кода с объявлением событий.
3. LIFECYCLE - участок кода с нативными методами MonoBehaviour (пр. Awake(), Start(), OnEnable() и др.).
4. EVENTS (2) - участок кода, с обработкой событий, на которые подписан текущий класс.
___
#лр_хороший_код
👍2