Compartilhar via


Comentários de código – // e /*. */

O C# dá suporte a duas formas diferentes de comentários. Os comentários de linha única começam com // e terminam no final dessa linha de código. Os comentários de várias linhas começam com /* e terminam com */. O código a seguir mostra um exemplo de cada um desses casos:

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

O comentário de várias linhas também pode ser usado para inserir texto em uma linha de código. Como esses comentários têm um caractere de fechamento explícito, você pode incluir um código mais executável após o comentário:

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

O comentário de linha única pode aparecer após o código executável na mesma linha. O comentário termina no final da linha de texto:

return source++; // increment the source.

Alguns comentários começam com três barras: ///. Comentários de barra tripla são comentários da documentação XML. O compilador os lê para produzir documentação humana. Você pode ler mais sobre comentários da documentação XML na seção de comentários de barra tripla.