Коментарі 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 // Виконання починається з основного методу

і

 // Друкує 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, використаний у вищезазначеній програмі, -

/// /// Це привітальна світова програма. ///

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

 Привіт Світ

Відвідайте коментарі до документації XML, якщо ви хочете дізнатись більше.

Правильно використовуйте коментарі

Коментарі використовуються для пояснення частин коду, але ними не слід зловживати.

Наприклад:

 // Друкує Hello World Console.WriteLine ("Hello World");

Використовувати коментар у наведеному вище прикладі не потрібно. Очевидно, що в рядку буде надруковано Hello World. У таких випадках слід уникати коментарів.

  • Натомість у програмі для пояснення складних алгоритмів та методів слід використовувати коментарі.
  • Коментарі повинні бути короткими та чіткими, а не довгим описом.
  • Як правило, краще пояснити, чому замість того , використовуючи коментарі.

Цікаві статті...