Оформление и структура класса

2021-01-24T17:41:08.392Z

В какой последовательности должны объявляться свойства и методы класса?

Введение

Читаемость кода является важным аспектом в программировании и поэтому существуют определенные стандарты, как в написании кода, так и в оформлении классов. Особенно это касается вью контроллеров, которые сами по себе являются довольно массивными объектами и поэтому навигация по ним должна быть предсказуемой, в не зависимости от того работаете ли вы со своим проектом или же со сторонним.

В этой не большой заметке я хочу расписать основные аспекты правильного оформления классов, что бы навигация по ним была интуитивно понятной, как для вас, так и для стороннего наблюдателя.

Структура класса

Класс начинается со свойств к которым относятся аутлеты, а также публичные и приватные переменные и константы:

Обратите внимание в какой последовательности объявлены свойства: сначала объявляются аутлеты, затем публичные переменные и константы, после которых уже идут приватные свойства. Так же обратите внимание на то, что аутлеты для лейблов разделяет пустая строка от аутлетов для текстовых полей. Такие разделители в виде пустых строк помогают визуально отделить логические блоки кода друг от друга, что повышает читаемость кода. Не пренебрегайте ими, но и не злоупотребляйте. Достаточно одной пустой строки, что бы отделить одно от другого.

При помощи пометки // MARK: класс можно поделить на разделы. Эти пометки играют роль заголовков, по которым можно быстро перемещаться. У каждого файла в проекте есть содержание, открыть которое можно, кликнув на название класса в верхней строке в которой прописан путь до класса:

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

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

После инициализаторов объявляются переопределенные методы родительского класса. Это те методы, которые помечены ключевым словом override. Если же вы работаете с вью контроллером, то переопределенные методы идут сразу после свойств класса:

После переопределенных методов объявляются IB Actions, т.е. методы связанные с пользовательским интерфейсом:

Далее идут методы экземпляра класса. Это публичные методы, которые можно вызвать из экземпляра:

И в самом конце класса объявляются приватные методы. Это те методы, которые используются исключительно внутри самого класса и не должны вызываться из экземпляра:

Так же классы могу иметь расширения или extensions. В них можно подписывать класс под протоколы и реализовывать методы эти протоколов , что бы все они были собраны в одном месте:

Так же можно делать расширения для приватных методов или, например для методов, которые позволяют работать с клавиатурой. Т.е. при помощи расширений можно агрегировать методы со схожими задачами. Кроме того расширения полезно использовать для распределения обязанностей между командой. В этом случае для каждого расширения создается отдельный файл, что позволяет работать над одним классом сразу нескольким участникам проекта.

В итоге структура класса должна выглядеть следующим образом:

Общие советы

Не храните в классе методы, которые ни как не используются. Т.е. если у вас есть метод viewDidLoad(), но при этом он пустой, то смело его удаляйте. Ни чего лишнего в коде быть не должно.
Удаляйте все шаблонные комментарии, которые достаются вам "из коробки" при добавлении новых классов.
Используйте в качестве разделителей логических блоков кода пустые строки, но не более одной.
Названия классов должны быть емкими и отражать их суть. В проекте не должно быть классов с именем `VViewControllerНе сокращайте имена классов. В проекте не должно быть классов с именем MainVC.

Alexey Efimov

Оформление и структура класса

В какой последовательности должны объявляться свойства и методы класса?

Введение

Структура класса

Общие советы