1.8. Comentarios

  Curso: Programación en C# (2015), por Nacho Cabanes

1.8. Comentarios

Podemos escribir comentarios, que el compilador ignorará, pero que pueden ser útiles para nosotros mismos, haciendo que sea más fácil recordar el cometido un fragmento del programa más adelante, cuando tengamos que ampliarlo o corregirlo.

Existen dos formas de indicar comentarios. En su forma más general, los escribiremos entre /* y */:

int suma;  /* Guardaré el valor para usarlo más tarde */

Es conveniente escribir comentarios que aclaren la misión de las partes de nuestros programas que puedan resultar menos claras a simple vista. Incluso suele ser aconsejable que el programa comience con un comentario, que nos recuerde qué hace el programa sin que necesitemos mirarlo de arriba a abajo. Un ejemplo casi exagerado podría ser:

/* ---- Ejemplo en C#: sumar dos números prefijados ---- */
 
public class Ejemplo_01_08a
{
    public static void Main()
    {
        int primerNumero = 234;
        int segundoNumero = 567;
        int suma;  /* Guardaré el valor para usarlo más tarde */
 
        /* Primero calculo la suma */
        suma = primerNumero + segundoNumero;
 
        /* Y después muestro su valor */
        System.Console.WriteLine("La suma de {0} y {1} es {2}", 
            primerNumero, segundoNumero, suma);
    }
}
 

Un comentario puede empezar en una línea y terminar en otra distinta, así:

      /*  Esto
          es un comentario que
          ocupa más de una línea
      */

También es posible declarar otro tipo de comentarios, que comienzan con doble barra y terminan cuando se acaba la línea (estos comentarios, claramente, no podrán ocupar más de una línea). Son los "comentarios de una línea" o "comentarios al estilo de C++" (a diferencia de los "comentarios de múltiples líneas" o "comentarios al estilo de C" que ya hemos visto):

      //  Este es un comentario "al estilo C++"

De modo que el programa anterior se podría reescribir usando comentarios de una línea:

// ---- Ejemplo en C#: sumar dos números prefijados ----
 
public class Ejemplo_01_08b
{
    public static void Main()
    {
        int primerNumero = 234;
        int segundoNumero = 567;
        int suma;  // Guardaré el valor para usarlo más tarde
 
        // Primero calculo la suma
        suma = primerNumero + segundoNumero;
 
        // Y después muestro su valor
        System.Console.WriteLine("La suma de {0} y {1} es {2}", 
            primerNumero, segundoNumero, suma);
    }
}
 

En este texto, a partir de ahora los fuentes comenzarán con un comentario que resuma su cometido, y en ocasiones incluirán también comentarios intermedios.

Ejercicios propuestos:

Ejercicio propuesto 1.8.1: Crea un programa que convierta una cantidad prefijada de metros (por ejemplo, 3000) a millas. La equivalencia es 1 milla = 1609 metros. Usa comentarios donde te parezca adecuado.

Actualizado el: 12-10-2014 00:54