Comentarios de C#

Comentarios de C#

En este artículo, aprenderemos sobre los comentarios de C#, los diferentes estilos de comentarios y por qué y cómo usarlos en un programa.

Los comentarios se utilizan en un programa para ayudarnos a comprender un fragmento de código. Son palabras legibles por humanos destinadas a hacer que el código sea legible. Los comentarios son completamente ignorados por el compilador.

En C#, hay 3 tipos de comentarios:

1. Comentarios de una sola línea ( // )
2. Comentarios de varias líneas (/* */ )
3. Comentarios XML ( /// )

---

Comentarios de una sola línea

Los comentarios de una sola línea comienzan con una barra inclinada doble // . El compilador ignora todo después de // hasta el final de la línea. Por ejemplo,

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

Aquí, Adding 5 and 7 es el comentario.

Ejemplo 1:Usar un comentario de una sola línea

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

El programa anterior contiene 3 comentarios de una sola línea:

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

y

// Prints Hello World

Los comentarios de una sola línea se pueden escribir en una línea separada o junto con los códigos en la misma línea. Sin embargo, se recomienda usar comentarios en una línea separada.

---

Comentarios de varias líneas

Los comentarios de varias líneas comienzan con /* y termina en */ . Los comentarios de varias líneas pueden abarcar varias líneas.

Ejemplo 2:uso de un comentario de varias líneas

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

El programa anterior contiene 2 comentarios de varias líneas:

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

y

/* Prints Hello World */

Aquí, es posible que hayamos notado que no es obligatorio que un comentario de varias líneas abarque varias líneas. /* … */ se puede usar en lugar de comentarios de una sola línea.

---

Comentarios de documentación XML

El comentario de documentación XML es una característica especial en C#. Comienza con una barra inclinada triple /// y se usa para describir categóricamente una pieza de código. Esto se hace usando etiquetas XML dentro de un comentario. Estos comentarios se utilizan luego para crear un archivo de documentación XML separado.

Si no está familiarizado con XML, consulte ¿Qué es XML?

Ejemplo 3:uso de comentarios de documentación 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!");
		}
	}
}

El comentario XML utilizado en el programa anterior es

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

La documentación XML (archivo .xml) generada contendrá:

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

Visite los comentarios de la documentación XML si está interesado en obtener más información.

---

Use los comentarios de la manera correcta

Los comentarios se utilizan para explicar partes del código, pero no deben abusarse.

Por ejemplo:

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

El uso de comentarios en el ejemplo anterior no es necesario. Es obvio que la línea imprimirá Hello World. Se deben evitar los comentarios en tales casos.

• En su lugar, se deben usar comentarios en el programa para explicar técnicas y algoritmos complejos.
• Los comentarios deben ser breves y directos en lugar de una descripción larga.
• Como regla general, es mejor explicar por qué en lugar de cómo , usando comentarios.