В этой статье вы узнаете о комментариях Swift, о том, почему и как их использовать.
Комментарий - это понятное программисту объяснение или аннотация в исходном коде программы. Компилятор игнорирует его при компиляции кода.
Комментарии предназначены для лиц, читающих код, чтобы лучше понять назначение и функциональность программы. Это может быть полезно при работе в команде, чтобы прояснить цель кода для других членов команды или во время работы в одиночку он может служить напоминанием о том, что нужно владеть.
Swift Comment и его типы
В swift есть два типа комментариев:
1. Однострочный комментарий
В Swift любая строка, начинающаяся с двух косых //черт, является однострочным комментарием. Все, что начинается с двух косых черт, //компилятор игнорирует.
Вы можете найти простой пример в верхней части детской площадки:
//: площадка - существительное: место, где люди могут играть
Он начинается с двух косых черт //и дает содержательное объяснение файла как «: площадка - существительное: место, где люди могут играть».
Пример 1: однострочный комментарий
//Sample program //stores 3.14 in variable pi let pi = 3.14159 print(pi)
Пример выше содержит два однострочных комментария:
// Пример программы // сохраняет 3,14 в переменной pi
2. Многострочный комментарий
Если ваш комментарий состоит из нескольких строк, вы можете заключить его внутрь /*… */.
Многострочные комментарии начинаются с косой черты, за которой следует звездочка ( /*), и заканчиваются звездочкой, за которой следует косая черта ( */). Все, что находится между ними /*и */игнорируется быстрым компилятором.
/ * Это многострочный комментарий. После того, как вы напишете многострочный комментарий, добавьте * после /, чтобы завершить его * /
Пример 2: Многострочный комментарий
/* Hardcoded pi value may be less accurate. So you can calculate using in built data types for more accurate value */ let pi = Double.pi print(pi)
В приведенном выше примере содержится многострочный комментарий.
/ * Жестко запрограммированное значение пи может быть менее точным. Таким образом, вы можете рассчитывать, используя встроенные типы данных для более точного значения * /
То, что нужно запомнить
Хотя комментарии имеют смысл, чтобы лучше понять цель написанного кода. Вот что нужно учитывать при написании:
- Не заключайте комментарии в многострочные символы //, хотя это допустимо, и компилятор игнорирует эти строки. Вместо этого заключите его в многострочный комментарий
/*… */
Пример:// Это комментарий. // Используем при необходимости и точно
Вышеупомянутый способ написания комментария является правильным, но не рекомендуется, поскольку вам нужно писать многострочные комментарии, если размер комментария превышает одну строку. Лучший способ написать - использовать многострочный комментарий как:/ * Это комментарий. Используйте его при необходимости и точно * /
- Однострочный комментарий можно записать в отдельной строке или вместе с кодом в той же строке. Однако рекомендуется использовать комментарии в отдельной строке.
Пример:let pi = 3.14159 // сохраняет 3,14 в переменной pi
Такой способ написания комментариев допустим. Но лучше написать комментарий отдельной строкой как:// сохраняет 3,14 в переменной pi let pi = 3,14159
- Даже если вы один разработчик в команде, и только вы пишете код, если он не прокомментирован, вам будет сложно понять его цель в программе. Так что используйте его точно и дайте содержательное описание.
- Сделайте комментарий очень простым и значимым.
- Не пишите лишних комментариев к вашему коду.
- В большинстве случаев используйте комментарии, чтобы объяснить «почему», а не «как».
