Поделиться через


Примечания кода — // и /*. */

C# поддерживает две различные формы комментариев. Отдельные строковый комментарий начинаются и // заканчиваются в конце этой строки кода. Несколько строковый комментарий начинаются с /* и заканчиваются*/. В следующем коде показан пример каждого из них:

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

Много строковый комментарий также можно использовать для вставки текста в строку кода. Так как эти примечания имеют явный символ закрытия, вы можете включить более исполняемый код после комментария:

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

Один строковый комментарий может отображаться после исполняемого кода в той же строке. Комментарий заканчивается в конце текстовой строки:

return source++; // increment the source.

Некоторые комментарии начинаются с трех косой черты: /// Примечания с тройной косой чертой — это комментарии к XML-документации. Компилятор считывает их для создания человеческой документации. Дополнительные сведения о комментариях к XML-документам см. в разделе о комментариях с тройной косой чертой.