sábado, 1 de noviembre de 2014

Comentar codigo en C#

Existen varias maneras de comentar código, y algunas maneras erróneas de hacerlo, aquí se explica de manera sencilla para hacerlo.
Como comentar el código
Comentar el código le permite añadir notas a sus archivos fuente de C#.  Estas notas pueden ayudarle a documentar el diseño y el funcionamiento de la aplicación. Puede colocar comentario en cualquier parte del código fuente de C# donde sea posible usar espacios en blanco.
Como usar comentarios de una linea
Los comentarios de una linea empiezan con dos barras inclinadas y afecta al resto de la linea.
//Esto es una llave de apertura
Console.WriteLine("C#");
//Esto es una llave de cierre
Uso de comentarios regulares
Los comentarios regulares empiezan con una barra inclinada seguida de un asterisco y su efecto permanece hasta que encuentrena un asterisco por una barra inclinada. Los comentarios regulares pueden extenderse por varias lineas:
/*
Esto es un comentario regular de C#.
Contiene varias lineas de texto,
separadas por caracteres NewLine.
*/
El compilador de C# no permite incrustar un comentario regular en otro.
/*
comentario externo
/*comentario interno
*/
mas texto de comentario externo
*/
No puede incrustar un comentario regular en otro por que el compilador encuentra los primeros caracteres */ y da por hecho que ha alcanzado el final del comentario de varias lineas. A continuación, supone que el siguiente texto seguido por los caracteres es codigo fuente de C# e intenta interpretarlo como tal.
Sin embargo, puede incrustar un comentario de una sola linea en un comentario regular.
/*
comentario externo
//comentario interno
mas comentario externo
*/

Fuente: Aqui

2 comentarios: