Комментарии (Comments)
Комментарии - это части исходного текста, которые компилятор Swift игнорирует при компиляции исходного кода. То есть это неисполняемые строки кода.
Комментарии используются для документирования написанного кода, добавления примечаний, заметок. Комментарии бывают однострочные и многострочные.
Однострочный комментарий начинается с двух символов косой черты, без пробела - //.
Текст после объявления однострочного комментария и до конца строки является комментарием.
Пример однострочного комментария:
// Это комментарий. Он не выполняется.
Однострочный комментарий можно записать на одной строке после части кода. Правило объявления и работы комментария то же: после объявления комментария и до конца строки текст будет восприниматься как комментарий.
var a = 5 // Это комментарий. Он не выполняется.
Однострочные комментарии можно записывать друг за другом в несколько строк таким образом, чтобы можно было писать абзацы:
// Это также комментарий.
// На нескольких строках.
Однако есть лучший способ писать комментарии, которые охватывают несколько строк. Это многострочные комментарии.
Многострочный комментарий начинается с двух символов: косая черта и “астерикс” - /*; заканчивается тоже двумя символами: “астерикс” и косая черта - */.
Текст между этими символами будет восприниматься как комментарий.
Пример многострочного комментария:
/* Это также комментарий.
Много...
много...
много строк. */
В отличии от однострочного комментария, многострочный комментарий имеет обозначение начала и конца, поэтому его можно встаить внутри строки кода. Например:
var array = [1, 2, /* комментарий */ 3, 4]
В языке Swift также можно вложить комментарии, например, так:
/*
Это комментарий.
/* И внутри него
находится
другой комментарий.*/
Вернемся к первому.
*/
Комментарии в XCode
В проекте комментарии можно использовать для добавления аннотаций к коду.
Есть несколько ключевых слов, которые можно использовать в коде:
- TODO - Добавление задачи - например, что-то доделать, переделать.
- FIXME - Добавление напоминания об исправлении ошибки - для пометки методов с ошибками.
- MARK - Добавление заголовка - используется для разделения методов на группы для более быстрого перехода между блоками методов.
- ??? - Добавление маркировки с указанием вопросов по коду
- !!! - Добавление маркировки для привлечения внимания
import UIKit
class ViewController: UIViewController {
// MARK: - View Life Cycle
override func viewDidLoad() {
super.viewDidLoad()
// Setup View
setupView()
}
// MARK: - View Methods
private func setupView() {
// Configure View
view.backgroundColor = .black
}
}
Такие обозначения позволяют лучше организовать код, создать определенную структуру кода и навигацию по коду, организовать совместную работу с кодом с несколькими разработчиками и работу по отладке приложения.
Более детально про организацию проекта с аннотацией кода смотреть в отдельной статье.
Еще полезные ссылки
Также информацию по комментариям можно получить на странице официальной документации.
Ссылки на официальную документацию: