C++ / comentarios

Bienvenidos sean a este post, hoy veremos como hacerlos mas comprensibles a nuestros codigos.

Comentar el código es como limpiar el cuarto de baño; nadie quiere hacerlo, pero el resultado es siempre una experiencia más agradable para uno mismo y sus invitados

Ryan Campbell

Esta es una frase que ejemplifica de la mejor manera lo que es comentar un codigo. Esto es asi porque siempre que dejemos un codigo por un tiempo nos costara volver a recordar para que servia. O si trabajamos en un proyecto, nos cambian del mismo y debemos dejarselo a otra persona. Si el codigo esta bien comentado, le facilitara la adaptacion a la nueva persona. Lo mismo para nosotros si vamos a ver un nuevo proyecto.

El comentario solamente es un texto que podemos intercalar en nuestro codigo para indicar algo. Ya sea, desde lo que hace esta seccion del codigo hasta una explicacion del mismo. Y su principal caracteristica es que todo lo comentado siempre es omitido por el compilador. Ya veremos porque esta conducta es muy pero muy importante para otro tema. Continuando con el tema, mencionarremos que tenemos dos forrmas de poner un comentario, veamos la primera:

// a partir de esto es solo un comentario

Esto se considera como una linea de comentario y solo es una linea de texto que omitira el compilador. Lo que este por fuera de esta linea no se considera como comentario. El otro tipo de comentario es el siguiente:

/*

Este es un bloque de comentario
y su principal ventaja
es que podemos usar varias lineas
para realizar un comentario.

*/

Como inidica el codigo, es un bloque de comentario donde usarmos un operador para iniciarlo y terminarlo. Todo lo que este dentro de estos operadores se considera como un comentario. Una ventaja con respecto al anterior, es que podemos tener varias lineas y poder dejar una mejor descripcion. Vamos a analizar el siguiente ejemplo:

/*
        Este es un bloque de comentario que usaremos al inicio.
        Aqui indicaremos varios detalles:

        Titulo: Ejemplo de comentario.
        Autor: tinchicus
        Objetivo: Mostrar el uso de comentarios.
*/

#include <iostream>

int main()
{
        // Aqui comenzaremos los mensajes a mostrar
        std::cout << "Esta es la linea 1" << std::endl;
        std::cout << "Esta es la linea 2" << std::endl; // comentario tambien
        std::cout << "Esta es la linea 3" << std::endl;
        std::cout << "Esta es la linea 4" << std::endl;
        std::cout << "Esta es la linea 5" << std::endl;
        // comentario final

        return 0;
}

Primero agregamos un bloque de comentario. Este lo usaremos para mostrar algunos datos basicos. Como son el titulo, el autor y el objetivo del codigo. Luego tenemos la inclusion de la libreria basica y nuestro codigo. En el main, tenemos cinco lineas y tres comentarios. Cada linea mostrara un mensaje distinto. El primer comentario estara para indicar que ahi comienzan los mensajes. El segundo comentario es mas particular porque lo usamos despues del codigo, por ejemplo pueden usarlo para indicar cual debe ser el valor en esa linea si realizara un calculo. Y el ultimo comentario simplemente indican el final. Compilemos y veamos como es la salida:

$ ./coment
Esta es la linea 1
Esta es la linea 2
Esta es la linea 3
Esta es la linea 4
Esta es la linea 5
$

Como pueden ver el codigo se ejecuto perfectamente y nuestros comentarios no afectaron nada. Recuerden lo que comentamos al inicio, el compilador omite todo lo que sea un comentario.

Ahora pasemos a hablar del verdadero uso que le dan a los comentarios, el 99.9% de los desarrolladores. Los comentarios por lo general se utilizan para anular una porcion del codigo cuando tenemos un inconveniente o reemplazamos una parte del codigo con otro pero no queremos eliminarlo por si lo necesitamos para otro tema. Modifiquemos el main del codigo anterior de la siguiente manera:

int main()
{
        // Aqui comenzaremos los mensajes a mosttrar
        std::cout << "Esta es la linea 1" << std::endl;
        std::cout << "Esta es la linea 2" << std::endl; // comentario tambien
        std::cout << "Esta es la linea 3" << std::endl;
        //std::cout << "Esta es la linea 4" << std::endl;
        std::cout << "Esta es la linea 5" << std::endl;
        // comentario final

        return 0;
}

En este caso, comentamos la linea que usamos para mostrar el mensaje de la linea 4. El resto sigue siendo el mismo codigo. Compilemos y veamos como trabaja ahora:

$ ./coment
Esta es la linea 1
Esta es la linea 2
Esta es la linea 3
Esta es la linea 5
$

Como pueden ver no mostro la linea 4. Porque como venimos diciendo, todo comentario es omitido por el compilador. Por lo tanto, esta linea dejo de existir para el codigo. Modifiquemos al main de la siguiente manera:

int main()
{
        // Aqui comenzaremos los mensajes a mosttrar
        std::cout << "Esta es la linea 1" << std::endl;
        /* std::cout << "Esta es la linea 2" << std::endl; // comentario tambien
        std::cout << "Esta es la linea 3" << std::endl;
        //std::cout << "Esta es la linea 4" << std::endl;
        std::cout << "Esta es la linea 5" << std::endl; */
        // comentario final

        return 0;
}

Aqui aplicamos un bloque de comentario para omitir desde la linea 2 hasta la 5. Dejando unicamente la linea 1 como parte de nuestro codigo. Si lo compilan y ejecutan tendra la siguiente salida:

$ ./coment
Esta es la linea 1
$

Como pueden ver todo lo que esta dentro del bloque de comentario fue omitido completamente por el compilador. Como dijimos esto es mayormente utilizado de esta manera. Por ejemplo, si agregamos nuevo codigo y nuestro programa dejo de funcionar despues de esto. Podemos comentarlo para ver si funciona nuevamente y partir de ahi ir comentando y descomentando progresivamente hasta descubrir la causa del error. O como dijimos antes, podemos comentar un bloque de codigo y este «desaparecera» del codigo pero estara ahi por si lo necesitamos para este u otro codigo.

Por lo tanto, esta mecanica nos puede ser util para varias cosas. Mas alla de la idea original por la que fue creada, tambien nos puede dar esta posibilidad para hacer una depuracion de nuestro codigo, poder aislar un error y solucionarlo. Pero sobre este tema hablaremos en el proximo post.

En resumen, hoy hemos visto comentarios, que es, para que sirve, como se utiliza, para que realmente sirve y una serie de ejemplos para ver en accion todas las opciones que podemos aplicar. Espero les haya resultado de utilidad sigueme en tumblr, Twitter o Facebook para recibir una notificacion cada vez que subo un nuevo post en este blog, nos vemos en el proximo post.