Комментарии в Swift

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

Swift, как и большинство других языков программирования, позволяет документировать код с помощью так называемых комментариев. Они позволяют писать любой текст непосредственно рядом с кодом и игнорируются компилятором.

Первый способ написания комментария выглядит следующим образом:

// Это комментарий. Он не выполняется.

Это однострочный комментарий.

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

// Это также комментарий.
// На нескольких строках.

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

/* Это также комментарий.
   Много...
   много...
   много строк. */

Это многострочный комментарий. Начало обозначается символом /*, а конец – символом */. Все просто!

Swift также позволяет вложить комментарии, например, так:

/* Это комментарий.
 /* И внутри него
 находится
 другой комментарий.
 */
 Вернемся к первому.
 */

Это может показаться не особенно интересным, но это может быть интересным, если вы знакомы с другими языками программирования. Многие из них не позволяют вложить комментарии подобным образом, так как, увидев первую */;, он думает, что вы закрываете первый комментарий.

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