Komentáře ke kódu – // a /* - */

Jazyk C# podporuje dvě různé formy komentářů. Jednořádkové komentáře začínají // a končí na konci tohoto řádku kódu. Víceřádkové komentáře začínají /* a končí na */.

Referenční dokumentace jazyka C# dokumentuje naposledy vydané verze jazyka C#. Obsahuje také počáteční dokumentaci k funkcím ve verzi Public Preview pro nadcházející jazykovou verzi.

Dokumentace identifikuje všechny funkce, které byly poprvé představeny v posledních třech verzích jazyka nebo v aktuálních verzích Public Preview.

Návod

Informace o tom, kdy byla funkce poprvé představena v jazyce C#, najdete v článku o historii verzí jazyka C#.

Následující kód ukazuje příklad každého formuláře:

// 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
   */

Pomocí víceřádkového komentáře můžete vložit text do řádku kódu. Vzhledem k tomu, že tyto komentáře mají explicitní uzavírací znak, můžete za komentář zahrnout další spustitelný kód:

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

Po spustitelném kódu na stejném řádku se může zobrazit jeden řádek komentáře. Komentář končí na konci řádku textu:

return source++; // increment the source.

Některé komentáře začínají třemi lomítky: ///. Komentáře s trojitým lomítkem jsou komentáře dokumentace XML. Kompilátor přečte tyto komentáře, aby vytvořil lidskou dokumentaci. Další informace o komentářích dokumentu XML najdete v části o komentářích s trojitým lomítkem.