Neste artigo, aprenderemos sobre os comentários C #, diferentes estilos de comentários e por que e como usá-los em um programa.
Os comentários são usados em um programa para nos ajudar a entender um trecho de código. Eles 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:
- Comentários de linha única (
//) - Comentários de várias linhas (
/* */) - 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 //o final da linha. Por exemplo,
int a = 5 + 7; // Adicionando 5 e 7
Aqui Adding 5 and 7está o comentário.
Exemplo 1: usando um 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 uma única linha:
// Programa Hello World // Execution Starts from Main method
e
// Imprime Hello World
Os comentários de uma única linha 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 terminam com */. Comentários de várias linhas podem se estender por 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:
/ * Este é um programa Hello World em C #. Este programa imprime Hello World. * /
e
/ * Imprime 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 uma única linha.
Comentários de documentação XML
O comentário da documentação XML é um recurso especial em C #. Ele começa com uma barra tripla ///e é usado para descrever categoricamente um trecho de código … Isso é feito usando tags XML em 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 o comentário da documentação XML
/// /// This is a hello world program. /// using System; namespace HelloWorld ( class Program ( public static void Main(string() args) ( Console.WriteLine("Hello World!"); ) ) )
O comentário XML usado no programa acima é
/// /// Este é um programa hello world. ///
A documentação XML (arquivo .xml) gerada conterá:
Olá Mundo
Visite Comentários da documentação XML se estiver interessado em aprender 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:
// Imprime Hello World Console.WriteLine ("Hello World");
Usar comentário no exemplo acima não é necessário. É óbvio que a linha imprimirá Hello World. Os comentários devem ser evitados em tais casos.
- Em vez disso, comentários devem ser usados no programa para explicar algoritmos e técnicas complexas.
- Os comentários devem ser curtos e diretos ao invés de uma descrição longa.
- Como regra geral, é melhor explicar por que em vez de como , usando comentários.
