1. Абстракции, контракты,
соглашения
Разработчики. Занятие 3

2. Абстракция данных – скрываем
детали структуры
Абстракция алгоритмов –
скрываем вспомогательные
функции
Принцип абстракции

3. Принцип абстракции
Основная цель – улучшить
понимание системы на
разных уровнях
Побочный эффект –
заменяемость
реализации

4. Абстрактный тип данных
(АТД) – описание данных и
алгоритмов (функций) для
манипулирования ими
Принцип абстракции

5. Примеры АТД:
Список (List)
Стек (Stack)
Очередь (Queue)
Дек (Deq)
Ассоциативный массив (Map)
Принцип абстракции

6. Движение программистской
мысли:
Машинный код
«Понятный» машинный код
(ассемблер)
«Понятный» ассемблер (Си)
Структурное программирование
Принцип абстракции

7. Движение программистской
мысли:
Процедурное и функциональное
программирование
Абстрактные типы данных
Принцип абстракции

8. Движение программистской
мысли:
Объектно-ориентированное
программирование
Функциональное
программирование (новый
уровень)
Принцип абстракции

9. Контракт функции –
спецификация, предусловие,
постусловие и инвариант
Контракты

10. Спецификация функции –
наименование, входные и
выходные параметры,
выбрасываемые исключения
Контракты

11. Контракт:
один из способов реализации
абстракции
Контракты

12. Класс -
один из способов реализации
абстрактного типа данных
Метод класса -
функция, имеющая доступ ко
всем данным класса
ООП (Java)

13. Спецификация метода – то
же, что и спецификация
функции + уровень доступа
ООП (Java)

14. Контракт класса –
наименование, структура
наследования, набор
спецификаций публичных
методов
ООП (Java)

15. Интерфейс –
чистое описание контракта класса
В Java НЕТ множественного
наследования, есть реализация
нескольких интерфейсов
ООП (Java)

16. Пакет –
совокупность классов, либо
совместно решающих общую
задачу, либо дающих разные
реализации одного контракта
ООП (Java)

17. Принцип Единственной
обязанности (Single Responsibility)
– у класса должно быть ровно
одно четкое предназначение
Признак нарушения –
невозможность подобрать
простое наименование
ООП (Java)

18. class Employee {
public:
Employee();
Employee (
FullName name,
String address,
String workPhone,
String homePhone,
);
virtual ~Employee();
FullName getName() const;
String getAddress() const;
String getWorkPhone() const;
String getHomePhone() const;
private:
...
};
ООП (Java)

19. class Program {
public:
void InitializeCommandStack();
void PushCommand(Command command);
Command PopCommand();
void ShutdownCommandStack();
void InitializeReportFormatting();
void FormatReport(Report report);
void PrintReport(Report report);
void InitializeGlobalData();
void ShutdownGlobalData();
private:
...
};
ООП (Java)

20. class EmployeeCensus: public ListContainer {
public:
void AddEmployee(Employee employee);
void RemoveEmployee(Employee employee);
Employee NextltemInList();
Employee Firstltem();
Employee Lastltem();
private:
...
};
ООП (Java)

21. class EmployeeCensus {
public:
void AddEmployee(Employee employee);
void RemoveEmployee(Employee employee);
Employee NextEmployee();
Employee FirstEmployee();
Employee LastEmployee();
private:
ListContainer m_EmployeeList;
...
};
ООП (Java)

22. Соглашения (конвенции)
именования – правила
наименования всех элементов
разрабатываемой системы
Соглашения

23. Уровни соглашений (по
возрастанию важности):
язык
фреймворк (библиотека)
компания (команда)
проект
Соглашения

24. Именование классов:
не использовать слова-связки
порядок: объект, имя
существительное – суть контракта,
дополнения и определения
Идеальный вариант – одно слово
Соглашения

25. Хорошо:
Employee, List, WebContext
Допустимо:
ReportManager, ContextHolder
Плохо:
AdderAndSubtracter, MyClass,
Program
Соглашения

26. Именование методов:
не использовать слова-связки,
порядок: глагол, объект
действия, дополнения и
определения
Соглашения

27. Именование переменных:
не использовать слова-связки,
объект, представляемый
переменной, возможно с
определением
Избегать: однобуквенных имен и
сильных сокращений слов
Соглашения

28. Разделение слов:
либо camelCase, либо символ
‘_’ - зависит от соглашений
языка
Соглашения

29. Классы в Java: camelCase, с
большой буквы
Методы и переменные в Java:
camelCase, с маленькой буквы
Пакеты в Java: одно слово с
маленькой буквы, первые 2
уровня – развернутый домен
Соглашения

30. Форматирование кода –
правила записи операторов и
других конструкций языка,
расстановки пробельных
символов и скобок для
улучшения читабельности
Соглашения

31. Помните:
код пишется только 10%
времени, а 90% времени его
читают
Соглашения

32. Документирование кода –
написание комментариев к
классам, методам,
определениям и другим
конструкциям
Документирование

33. JavaDoc – утилита для сборки
документации к проекту в
формате HTML
Иногда так называют сами
комментарии к классам и методам
Документирование

34. Пример для класса:
/**
* Provides a company employee
* entity
*/
class Employee {
Документирование

35. Пример для метода:
/**
* Counts employee in a given container
* @param employeeContainer a container of employees
* @return a count of employees in a given container
*/
int countEmployees(
final EmployeeContainer employeeContainer
) {
Документирование

36. Самодокументирующийся код
– код, являющийся
документаций сам себе и не
требующий пояснений в виде
комментариев
Документирование

37. Хорошо документированный
код – контракты
документированы JavaDoc (или
аналогом), тела методов –
самодокументирующийся код
Документирование