Советы по написанию кода.

Именование, массивы, перечисления

О себеВоробьев Артем

Разработчик игр вSofteq Development

artyom.vorobyov

arvorobyov

artyom.vorobyov@softeq.com

О чем будем говорить:

• Документирование кода

• Советы по именованию

• Использование массивов и перечислений

1. Документирование кода

• Написание специальных документов

• Использование соглашений

• Написание комментариев

• Названия классов, переменных, методов и констант

• Использование архитектурных схем

Использование соглашений

• Гайдлайн – это требования, советы и рекомендации

• Можно использовать гайдлайны известных разработчиков (Google, Apple и т.д.)

• Соглашения могут касаться разных аспектов:

• Когда и как писать комментарии

• Как называть классы

• Как рисовать архитектурные схемы

• Как группировать код

Группировка строк кода (1)

Группировка строк кода (2)

Группировка строк кода (3)

Группировка строк кода (4)

Группировка методов

Написание комментариев

Пишем комментарии

• К блокам кода для группировки

• К интерфейсу классов и методов

• К частям сложного алгоритма для пояснения хода вычислений

• К неочевидным строкам кода (такие комментарии обычно указывают на плохой код)

Комментарии к интерфейсу (1)

Комментарии к интерфейсу (2)

• Здесь использована нотация Javadoc

• Комментируем сам класс, в общем описывая что это такое, для чего нужно и как им пользоваться

• Комментируем public-методы класса

Комментарии к интерфейсу (3)

• Комментарии к интерфейсу тяжело писать только первые пару раз

• Комментарии к интерфейсу лучше писать до того, как реализовывать этот интерфейс

• Если вы не можете сформулировать комментарий, это может указывать на ошибку проектирования

2. Именование

• Используем префиксы к именам классов

• Группирующее слово пишем первым в имени класса

• Группирующее слово пишем первым в имени переменной

Префиксы к именам классов

Группирующее слово в имени класса

Группирующее слово в имени переменной

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

• Плохое использование венгерской нотации: привязка исключительно к типу (dw – Double Word, i – Int, b – Byte и т.д.)

• Хрошее использование венгерской нотации: привязка к контексту:

int humanHeight;

float humanWeight

float animalWeight;

Архитектурные схемы (1)

Архитектурные схемы (2)

• Рисуем на листиках или на доске

• Фотографируем схемы с листика или доски

• Храним фотографии как документацию к проекту

• Схемы можно распечатать и делать на них пометки при дальнейшей работе

• Используйте диаграммы классов из UML и OMT (Object Modelling Technique)

3. Использование массивов

Сворачивание данных в массив• Имеет смысл делать, если вы видите

последовательные блоки кода, осуществляющие однотипные операции над разными объектами

• Упрощает сопровождаемость кода

• Позволяет масштабировать код – если объектов станет больше чем 3, это потребует всего-лишь увеличения массива

• Может быть нецелесообразным в высокопроизводительном коде из-за дополнительных условных операторов

Пример: человек на поле

Сдвинуть человека на соседнюю клетку

То же, с помощью перечисления

Двигаем человека на соседнюю клетку

Макросы для перечислений

Цикл с макросами

Если нужно поменять порядок направлений

Спасибо! Вопросы?

?Воробьев Артем

Разработчик игр в Softeq Development

Skype: artyom.vorobyov

обращайтесь!