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

В этой статье вы узнаете о Swift-комментариях, почему и как их использовать.

Комментарии - это читаемые пояснения или комментарии программиста в исходном коде программы. При компиляции кода компилятор игнорирует их.

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

Swift-комментарии и их типы

Swift имеет два типа комментариев:

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

В Swift любая строка, начинающаяся с двух косых черт //, является однстрочным комментарием, и все строки, начинающиеся с двух косых черт //, игнорируются компилятором.

Вы можете найти простые примеры в верхней части playground

//: Playground - сущность: место, где люди могут играть

Они начинаются с двух косых черт // и предоставляют полезное объяснение файла, например: «Playground - сущность: место, где люди могут играть».

Пример 1: однстрочные комментарии

//Пример программы
//Сохраняет 3.14 в переменную pi
let pi = 3.14159　
print(pi)

В приведенном выше примере содержатся два однстрочных комментария:

//　Пример программы
//　хранит 3.14 в переменной pi

2. многострочные комментарии

Если ваши комментарии содержат несколько строк, вы можете их заключить в /*...*/.

Многострочные комментарии начинаются с обратной косой черты и звездочки (/*), заканчиваются звездочкой и обратной косой чертой (*/), и Swift-компилятор игнорирует все содержимое между ними.

/*　Это многострочный комментарий.
Добавьте * после написания многострочных комментариев, а затем /, чтобы завершить их
*/

Пример 2: многострочные комментарии

/*　Жестко заданный значение pi может быть не таким точным.
Таким образом, вы можете использовать встроенные типы данных для вычисления более точных значений
*/
let pi = Double.pi
print(pi)

В приведенном выше примере содержатся многострочные комментарии.

/*　Жестко заданный значение pi может быть не таким точным.
Таким образом, вы можете использовать встроенные типы данных для вычисления более точных значений
*/

Важно помнить

Хотя комментарии очень важны для лучшего понимания намерений написанного кода. Но следует помнить:

1. Не включайте комментарии в // в многострочных комментариях, хотя это эффективно и компилятор игнорирует эти строки. Напротив, их следует поместить в многострочные комментарии /* ... */
   Например:

   //Это комментарий.
   //Используйте его, когда это необходимо и точно

   Этот метод записи комментариев правильный, но不建议这样做, потому что если комментарии занимают более одной строки, то их нужно записывать на нескольких строках. Лучше использовать многострочные комментарии в качестве:

   /* Это комментарий.*/
   Используйте это, когда необходимо и точно
   */

2. Однострочные комментарии могут быть写在 отдельной строке или написаны вместе с кодом на одной строке. Но рекомендуется использовать комментарии в отдельной строке.
   Например:

   let pi = 3.14159 //Сохраняет 3.14 в переменную pi

   Этот способ написания комментариев эффективен. Но лучше пишите комментарии в отдельной строке:
   

   //Сохраняет 3.14 в переменную pi
   let pi = 3.14159

3. Даже если вы единственный разработчик в команде и единственный, кто пишет код, без комментариев найти использование кода в программе очень трудно. Поэтому используйте его точно и предоставляйте значимое описание.

4. Сделайте комментарии очень простыми и значимыми.

5. Не пишите избыточные комментарии в коде.

6. В большинстве случаев, используйте комментарии для объяснения «почему» вместо «как».