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:
- Comentarios de una sola línea (
//) - Comentarios de varias líneas (
/* */) - Comentarios XML (
///)
Comentarios de una sola línea
Los comentarios de una sola línea comienzan con una barra doble //. El compilador ignora todo lo que sigue //hasta el final de la línea. Por ejemplo,
int a = 5 + 7; // Sumando 5 y 7
Aquí Adding 5 and 7está el comentario.
Ejemplo 1: uso de comentarios 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:
// Programa Hello World // La ejecución comienza desde el método principal
y
// Imprime 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 utilizar los comentarios en una línea separada.
Comentarios de varias líneas
Los comentarios de varias líneas comienzan con /*y terminan con */. Los comentarios de varias líneas pueden abarcar varias líneas.
Ejemplo 2: uso de comentarios 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:
/ * Este es un programa Hello World en C #. Este programa imprime Hello World. * /
y
/ * Imprime Hello World * /
Aquí, podemos haber notado que no es obligatorio que un comentario de varias líneas abarque varias líneas. /*… */se puede utilizar 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 triple ///y se usa para describir categóricamente un fragmento de código … Esto se hace usando etiquetas XML dentro de un comentario. Estos comentarios se utilizan para crear un archivo de documentación XML independiente.
Si no está familiarizado con XML, consulte ¿Qué es XML?
Ejemplo 3: uso de un comentario de documentación XML
/// /// This is a hello world program. /// 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
/// /// Este es un programa de hola mundo. ///
La documentación XML (archivo .xml) generada contendrá:
Hola Mundo
Visite Comentarios de documentación XML si está interesado en obtener más información.
Utilice los comentarios de la manera correcta
Los comentarios se utilizan para explicar partes del código, pero no deben utilizarse en exceso.
Por ejemplo:
// Imprime Hello World Console.WriteLine ("Hello World");
No es necesario utilizar el comentario en el ejemplo anterior. Es obvio que la línea imprimirá Hello World. En tales casos, deben evitarse los comentarios.
- En su lugar, los comentarios deben usarse 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 , utilizando comentarios.
