Udostępnij za pośrednictwem


Komentarze kodu — // i /*. */

Język C# obsługuje dwie różne formy komentarzy. Komentarze jednowierszowe zaczynają się od i kończą // się na końcu tego wiersza kodu. Komentarze wielowierszowe zaczynają się od i kończą się /* ciągiem */. Poniższy kod przedstawia przykład każdego z nich:

// This is a single line comment.

/* This could be a summary of all the
   code that's in this class.
   You might add multiple paragraphs, or links to pages
   like https://learn.microsoft.com/dotnet/csharp.
   
   You could even include emojis. This example is 🔥
   Then, when you're done, close with
   */

Komentarz wielowierszowy może również służyć do wstawiania tekstu w wierszu kodu. Ponieważ te komentarze mają jawny znak zamykający, po komentarzu można uwzględnić więcej kodu wykonywalnego:

public static int Add(int left, int right)
{
    return left /* first operand */ + right /* second operand */;
}

Komentarz w jednym wierszu może pojawić się po kodzie wykonywalny w tym samym wierszu. Komentarz kończy się na końcu wiersza tekstu:

return source++; // increment the source.

Niektóre komentarze zaczynają się od trzech ukośników: ///. Komentarze potrójnego ukośnika to komentarze dokumentacji XML. Kompilator odczytuje je w celu utworzenia dokumentacji ludzkiej. Więcej informacji na temat komentarzy doc XML można przeczytać w sekcji dotyczącej komentarzy potrójnych ukośnika.