Комментарии C #: как их использовать и зачем?

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

Комментарии используются в программе, чтобы помочь нам понять фрагмент кода. Это удобочитаемые слова, предназначенные для чтения кода. Комментарии полностью игнорируются компилятором.

В C # есть 3 типа комментариев:

  1. Однострочные комментарии ( //)
  2. Многострочные комментарии ( /* */)
  3. Комментарии XML ( ///)

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

Однострочные комментарии начинаются с двойной косой черты //. Компилятор игнорирует все после //до конца строки. Например,

int a = 5 + 7; // Добавляем 5 и 7

Вот Adding 5 and 7комментарий.

Пример 1: Использование однострочного комментария

 // Hello World Program using System; namespace HelloWorld ( class Program ( public static void Main(string() args) // Execution Starts from Main method ( // Prints Hello World Console.WriteLine("Hello World!"); ) ) )

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

 // Программа Hello World // Выполнение начинается с метода Main

и

 // Выводит Hello World

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

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

Многострочные комментарии начинаются с /*и заканчиваются */. Многострочные комментарии могут занимать несколько строк.

Пример 2: Использование многострочного комментария

 /* This is a Hello World Program in C#. This program prints Hello World. */ using System; namespace HelloWorld ( class Program ( public static void Main(string() args) ( /* Prints Hello World */ Console.WriteLine("Hello World!"); ) ) )

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

/ * Это программа Hello World на C #. Эта программа печатает Hello World. * /

и

 / * Печатает Hello World * /

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

Комментарии к документации XML

Комментарий к документации XML - это особая функция C #. Он начинается с тройной косой черты ///и используется для категорического описания фрагмента кода… Это делается с помощью тегов XML в комментарии. Эти комментарии затем используются для создания отдельного файла документации XML.

Если вы не знакомы с XML, см. Что такое XML?

Пример 3: Использование комментария к документации XML

 /// /// This is a hello world program. /// using System; namespace HelloWorld ( class Program ( public static void Main(string() args) ( Console.WriteLine("Hello World!"); ) ) )

Комментарий XML, используемый в приведенной выше программе:

/// /// Это программа hello world. ///

Сгенерированная XML-документация (файл .xml) будет содержать:

 Привет мир

Посетите Комментарии к XML-документации, если вы хотите узнать больше.

Используйте комментарии правильно

Комментарии используются для объяснения частей кода, но не следует злоупотреблять ими.

Например:

 // Выводит Hello World Console.WriteLine ("Hello World");

Использование комментария в приведенном выше примере не обязательно. Очевидно, что в строке будет напечатано Hello World. В таких случаях следует избегать комментариев.

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

Интересные статьи...