Komentarze w języku C #: jak ich używać i dlaczego?

W tym artykule dowiemy się o komentarzach C #, różnych stylach komentarzy oraz dlaczego i jak ich używać w programie.

Komentarze są używane w programie, aby pomóc nam zrozumieć fragment kodu. Są to czytelne dla człowieka słowa, które mają na celu uczynienie kodu czytelnym. Komentarze są całkowicie ignorowane przez kompilator.

W języku C # istnieją 3 typy komentarzy:

  1. Komentarze jednowierszowe ( //)
  2. Komentarze wielowierszowe ( /* */)
  3. Komentarze XML ( ///)

Komentarze jednowierszowe

Komentarze jednowierszowe zaczynają się od podwójnego ukośnika //. Kompilator ignoruje wszystko od //końca wiersza. Na przykład,

int a = 5 + 7; // Dodanie 5 i 7

Tutaj Adding 5 and 7jest komentarz.

Przykład 1: Korzystanie z komentarza jednowierszowego

 // 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!"); ) ) )

Powyższy program zawiera 3 jednowierszowe komentarze:

 // Hello World Program // Wykonanie rozpoczyna się od metody Main

i

 // Drukuje Hello World

Komentarze jednowierszowe mogą być wpisywane w osobnym wierszu lub wraz z kodami w tym samym wierszu. Zaleca się jednak umieszczanie komentarzy w osobnym wierszu.

Komentarze wieloliniowe

Komentarze wieloliniowe zaczynają się /*i kończą na */. Komentarze wieloliniowe mogą obejmować wiele linii.

Przykład 2: Korzystanie z komentarza wieloliniowego

 /* 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!"); ) ) )

Powyższy program zawiera 2 wieloliniowe komentarze:

/ * To jest program Hello World w C #. Ten program drukuje Hello World. * /

i

 / * Prints Hello World * /

W tym miejscu mogliśmy zauważyć, że komentarz wielowierszowy nie jest obowiązkowy, aby obejmował wiele wierszy. /*… */można używać zamiast komentarzy jednowierszowych.

Komentarze do dokumentacji XML

Komentarz dokumentacji XML to specjalna funkcja w języku C #. Zaczyna się od potrójnego ukośnika ///i służy do kategorycznego opisania fragmentu kodu… Odbywa się to za pomocą tagów XML w komentarzu. Te komentarze są następnie używane do tworzenia oddzielnego pliku dokumentacji XML.

Jeśli nie znasz języka XML, zobacz Co to jest XML?

Przykład 3: Korzystanie z komentarza do dokumentacji XML

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

Komentarz XML użyty w powyższym programie to

/// /// To jest program Hello World. ///

Wygenerowana dokumentacja XML (plik .xml) będzie zawierać:

 Witaj świecie

Odwiedź Komentarze do dokumentacji XML, jeśli chcesz dowiedzieć się więcej.

Używaj komentarzy we właściwy sposób

Komentarze służą do wyjaśniania części kodu, ale nie należy ich nadużywać.

Na przykład:

 // Wyświetla Hello World Console.WriteLine ("Hello World");

Używanie komentarza w powyższym przykładzie nie jest konieczne. Jest oczywiste, że w wierszu zostanie wydrukowany Hello World. W takich przypadkach należy unikać komentarzy.

  • Zamiast tego w programie należy używać komentarzy w celu wyjaśnienia złożonych algorytmów i technik.
  • Komentarze powinny być krótkie i na temat zamiast długiego opisu.
  • Z reguły lepiej jest wyjaśnić, dlaczego zamiast jak , używając komentarzy.

Interesujące artykuły...