Воробьёв Артём, Минск. Работал программистом в сфере защиты информации, затем перешел в область мобильных разработок, сейчас занимается разработкой игр для мобильных устройств. «Советы по написанию кода: именование, массивы и перечисления». Development секция. Для студентов и разработчиков.В презентации будут даны некоторые советы по именованию переменных и классов, а также некоторые соображения по использованию массивов и перечислений для написания более качественного кода. В презентации для пояснения идей будут использованы небольшие куски кода.

1. Советы по написанию кода.
Именование, массивы, перечисления

2. О себе
Воробьев Артем
Разработчик игр в
Softeq Development
artyom.vorobyov
arvorobyov
artyom.vorobyov@softeq.com

3. О чем будем говорить:
• Документирование кода
• Советы по именованию
• Использование массивов и
перечислений

4. 1. Документирование кода
• Написание специальных документов
• Использование соглашений
• Написание комментариев
• Названия классов, переменных, методов и
констант
• Использование архитектурных схем

5. Использование соглашений
• Гайдлайн – это требования, советы и
рекомендации
• Можно использовать гайдлайны известных
разработчиков (Google, Apple и т.д.)
• Соглашения могут касаться разных аспектов:
• Когда и как писать комментарии
• Как называть классы
• Как рисовать архитектурные схемы
• Как группировать код

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

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

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

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

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

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

12. Пишем комментарии
• К блокам кода для группировки
• К интерфейсу классов и методов
• К частям сложного алгоритма для
пояснения хода вычислений
• К неочевидным строкам кода (такие
комментарии обычно указывают на плохой
код)

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

14. Комментарии к интерфейсу (2)
• Здесь использована
нотация Javadoc
• Комментируем сам
класс, в общем
описывая что это
такое, для чего нужно
и как им пользоваться
• Комментируем public-
методы класса

15. Комментарии к интерфейсу (3)
• Комментарии к интерфейсу тяжело писать
только первые пару раз
• Комментарии к интерфейсу лучше писать
до того, как реализовывать этот
интерфейс
• Если вы не можете сформулировать
комментарий, это может указывать на
ошибку проектирования

16. 2. Именование
• Используем префиксы к именам классов
• Группирующее слово пишем первым в
имени класса
• Группирующее слово пишем первым в
имени переменной

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

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

19. Группирующее слово в имени
переменной
• Венгерская нотация
• Плохое использование венгерской нотации:
привязка исключительно к типу (dw –
Double Word, i – Int, b – Byte и т.д.)
• Хрошее использование венгерской нотации:
привязка к контексту:
int humanHeight;
float humanWeight
float animalWeight;

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

21. Архитектурные схемы (2)
• Рисуем на листиках или на доске
• Фотографируем схемы с листика или доски
• Храним фотографии как документацию к
проекту
• Схемы можно распечатать и делать на них
пометки при дальнейшей работе
• Используйте диаграммы классов из UML и
OMT (Object Modelling Technique)

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

23. Сворачивание данных в массив
• Имеет смысл делать, если вы видите
последовательные блоки
кода, осуществляющие однотипные операции
над разными объектами
• Упрощает сопровождаемость кода
• Позволяет масштабировать код – если
объектов станет больше чем 3, это потребует
всего-лишь увеличения массива
• Может быть нецелесообразным в
высокопроизводительном коде из-за
дополнительных условных операторов

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

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

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

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

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

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

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

31. Спасибо! Вопросы?
Воробьев Артем
Разработчик игр в
Softeq Development
Skype: artyom.vorobyov
обращайтесь!