Большинство iOS-команд с трудом приводят в порядок свой код. Это связано с тем, что некоторые члены команды, вероятно, не следуют соглашениям о коде Swift или используют свой собственный стиль кода (особенно младшие инженеры), потому что они склонны забывать или не знать о соглашениях о коде Swift.
Не буду врать, я был одним из тех младших инженеров, когда только начинал программировать на Swift.
Но я нашел некоторые приемы, которые предоставляет XCode, и эти приемы сделали мою жизнь проще. Конечно, мне не нужно будет так часто убирать свой код, потому что я уже заставляю себя следовать соглашению о коде Swift или моей команды. Но эти приемы могут быть полезны для нас в обычных случаях.
Это 2 простых трюка, которые я нашел, и их достаточно, чтобы помочь нам в конечном итоге привести в порядок наш код Swift:
изменение отступа
XCode имеет свою собственную функцию повторного отступа с помощью Control + I. Мы можем изменить отступ всего нашего кода в файле (используя Command + A) или просто изменить отступ части нашего кода (выбрав область кода). После выбора нашего кода просто нажмите Control + I, и все заработает как по волшебству!
Мы также можем настроить пространство отступа в настройках проекта XCode, перейдя в XCode › Настройки… › Редактирование текста › Отступ.
Документация по автоматическому созданию кода
Вы создали несколько компонентов/функций многократного использования в Swift, но склонны забывать задачу каждого компонента/функции и ее использование? Вот тут-то и пригодится документация по коду!
Обычно мы создавали нашу документацию по коду вручную, верно? используя многострочный комментарий и вводя его функцию, параметры и т. д. Но это звучит неудобно для меня (я слишком ленив, чтобы делать это, если честно).
Что ж, не беспокойтесь, у XCode есть собственный генератор документации кода, и мы можем использовать его где угодно, пока мы редактируем файл Swift и в XCode!
Представляем ярлык «Command + Option + /», ярлык, который может волшебным образом генерировать наш код на основе компонента/функции. Этот ярлык может сократить наше время на документирование кода и пригодится в случае необходимости (я недавно тоже использовал этот ярлык).
Просто поместите курсор над недокументированной функцией/классом и нажмите «Command + Option + /», чтобы сгенерировать заголовок функции/класса.
Вы также можете использовать «Tab» и «Shift + Tab», чтобы перемещаться вперед и назад по блоку комментариев.
Бонус: используйте Линтер
Теперь, когда мы знаем, как привести в порядок наш код, иногда нам трудно найти беспорядочные коды, верно? Используйте Линтер.
Lint или линтер — это инструмент статического анализа кода, используемый для пометки ошибок программирования, ошибок, стилистических ошибок и подозрительных конструкций (согласно Википедии). Это может помочь нам выявить ошибки стиля кода или те, которые не соответствуют соглашению о коде.
Существует множество линтеров для Swift, и наиболее часто используемыми являются SwiftLint, SwiftFormat и Tailor. Вы можете попробовать один из линтеров!
Вот и все, что нужно для приведения в порядок наших советов по коду Swift! Надеюсь, вы найдете эту статью полезной. Если вы найдете еще один полезный совет, можете оставить комментарий ниже, при необходимости я добавлю его в статью! Спасибо за чтение!
