Ц # коментари: Како их користити и зашто?

У овом чланку ћемо научити о Ц # коментарима, различитом стилу коментара и зашто и како их користити у програму.

Коментари се користе у програму како би нам помогли да разумемо комад кода. То су човеку читљиве речи којима је циљ да код буде читљив. Компајлер је коментаре потпуно игнорисао.

У Ц # постоје 3 врсте коментара:

  1. Једноредни коментари ( //)
  2. Вишередни коментари ( /* */)
  3. КСМЛ коментари ( ///)

Једноредни коментари

Једноредни коментари почињу двоструком косом цртом //. Компајлер игнорише све после //до краја реда. На пример,

инт а = 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 коментара у једном реду:

 // Програм Хелло Ворлд // Извршење започиње од главне методе

и

 // Штампа Хелло Ворлд

Једноредни коментари се могу писати у засебном реду или заједно са кодовима у истом реду. Међутим, препоручује се коришћење коментара у посебном реду.

Вишередни коментари

Вишередни коментари почињу са /*и завршавају се са */. Коментари са више редова могу се протезати у више редова.

Пример 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 вишередна коментара:

/ * Ово је програм Хелло Ворлд на језику Ц #. Овај програм штампа Хелло Ворлд. * /

и

 / * Штампа Хелло Ворлд * /

Овде смо можда приметили да није обавезно да се вишередни коментар протеже преко више редова. /*… */може се користити уместо једноструких коментара.

Коментари КСМЛ документације

Коментар КСМЛ документације је посебна карактеристика у Ц #. Почиње с троструком косом цртом ///и користи се за категоричан опис дијела кода … То се ради помоћу КСМЛ ознака у коментару. Ови коментари се затим користе за стварање посебне датотеке КСМЛ документације.

Ако нисте упознати са КСМЛ-ом, погледајте Шта је КСМЛ?

Пример 3: Коришћење коментара о КСМЛ документацији

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

КСМЛ коментар кориштен у горњем програму је

/// /// Ово је здраво светски програм. ///

Генерирана КСМЛ документација (.кмл датотека) садржаће:

 Здраво Свете

Посетите коментаре КСМЛ документације ако сте заинтересовани да сазнате више.

Користите коментаре на прави начин

Коментари се користе за објашњење делова кода, али их не треба претерано користити.

На пример:

 // Штампа Хелло Ворлд Цонсоле.ВритеЛине ("Хелло Ворлд");

Употреба коментара у горњем примеру није потребна. Очигледно је да ће се на линији исписати Хелло Ворлд. У таквим случајевима треба избегавати коментаре.

  • Уместо тога, у програму треба користити коментаре за објашњавање сложених алгоритама и техника.
  • Коментари би требали бити кратки и прецизни, уместо дугог описа.
  • Као правило, боље је објаснити зашто, уместо како , користећи коментаре.

Занимљиви Чланци...