Comentários em C#

Comentários em C#

Neste artigo, aprenderemos sobre comentários em C#, diferentes estilos de comentários e por que e como usá-los em um programa.

Comentários são usados ​​em um programa para nos ajudar a entender um pedaço de código. São palavras legíveis por humanos destinadas a tornar o código legível. Os comentários são completamente ignorados pelo compilador.

Em C#, existem 3 tipos de comentários:

1. Comentários de linha única ( // )
2. Comentários de várias linhas (/* */ )
3. Comentários XML ( /// )

---

Comentários de linha única

Comentários de linha única começam com uma barra dupla // . O compilador ignora tudo após // até o final da linha. Por exemplo,

int a = 5 + 7; // Adding 5 and 7

Aqui, Adding 5 and 7 é o comentário.

Exemplo 1:usando comentário de linha única

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

O programa acima contém 3 comentários de linha única:

// Hello World Program
// Execution Starts from Main method

e

// Prints Hello World

Comentários de linha única podem ser escritos em uma linha separada ou junto com os códigos na mesma linha. No entanto, é recomendável usar comentários em uma linha separada.

---

Comentários de várias linhas

Comentários de várias linhas começam com /* e termina com */ . Comentários de várias linhas podem abranger várias linhas.

Exemplo 2:usando comentários de várias linhas

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

O programa acima contém 2 comentários de várias linhas:

/*
This is a Hello World Program in C#.
This program prints Hello World.
*/

e

/* Prints Hello World */

Aqui, podemos ter notado que não é obrigatório que um comentário de várias linhas se estenda por várias linhas. /* … */ pode ser usado em vez de comentários de linha única.

---

Comentários da documentação XML

O comentário de documentação XML é um recurso especial em C#. Começa com uma barra tripla /// e é usado para descrever categoricamente um pedaço de código. Isso é feito usando tags XML dentro de um comentário. Esses comentários são então usados ​​para criar um arquivo de documentação XML separado.

Se você não estiver familiarizado com XML, consulte O que é XML?

Exemplo 3:usando comentário de documentação XML

/// <summary>
///  This is a hello world program.
/// </summary>

using System;

namespace HelloWorld
{
	class Program
	{
		public static void Main(string[] args)
		{
			Console.WriteLine("Hello World!");
		}
	}
}

O comentário XML usado no programa acima é

/// <summary>
/// This is a hello world program.
/// </summary>

A documentação XML (arquivo .xml) gerada conterá:

<?xml version="1.0"?>
<doc>
	<assembly>
		<name>HelloWorld</name>
	</assembly>
	<members>
	</members>
</doc>

Visite Comentários da Documentação XML se estiver interessado em saber mais.

---

Use os comentários da maneira certa

Os comentários são usados ​​para explicar partes do código, mas não devem ser usados ​​em demasia.

Por exemplo:

// Prints Hello World
Console.WriteLine("Hello World");

Usar comentário no exemplo acima não é necessário. É óbvio que a linha imprimirá Hello World. Comentários devem ser evitados nesses casos.

• Em vez disso, os comentários devem ser usados ​​no programa para explicar algoritmos e técnicas complexas.
• Os comentários devem ser curtos e diretos, em vez de uma descrição longa.
• Como regra geral, é melhor explicar por que em vez de como , usando comentários.