В тази статия ще научим за коментари на C #, различен стил на коментари и защо и как да ги използваме в програма.
Коментарите се използват в програма, за да ни помогнат да разберем част от кода. Те са човешки четливи думи, предназначени да направят кода четлив. Коментарите са напълно игнорирани от компилатора.
В C # има 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. В такива случаи трябва да се избягват коментари.
- Вместо това в програмата трябва да се използват коментари за обяснение на сложни алгоритми и техники.
- Коментарите трябва да са кратки и точни, вместо дълго описание.
- Като правило е по-добре да обясните защо, вместо как , като използвате коментари.
