I.4 Comentando el código

Recuerdas el programa original creado por Anjuta:

/* Created by Anjuta version 1.2.4a */
/*    This file will not be overwritten */

#include <iostream>
int main()
{
    std::cout << "Hello world" << std::endl;
    return 0;
}
Las dos primeras líneas:
 /* Created by Anjuta version 1.2.4a */
/*    This file will not be overwritten */

Son comentarios, texto que se introduce en un programa para explicarlo.

Es buena práctica ir comentando lo que se hace, porque de lo contrario reutilizar o depurar el código, pasado un cierto tiempo puede convertirse en tarea imposible (por muy "humano" que sea el C++).

Existen dos formas de hacer comentarios en C++:
  • Una heredada de C, los comentarios comienzan con '/*' y terminan con '*/'. Este tipo de comentario es útil en: 
    • largas explicaciones:
/******************************************************************
   Calcular la media ponderada de la nota de los tres trimestres
el primer trimestre debe tener una valoración del 30 %
el segundo, el más importante, 40%
el tercero el restante 30%
******************************************************************/
    • Modificación de pequeños fragmentos de código.
Este aspecto es muy interesante para depurar programas (corregir errores de programación -a veces los programas no hacen exactamente lo que queremos, errar es humano y en programación somos todos muy humanos).

Por ejemplo:
std::cout <</*"X =" << x <<*/"Y= " << y;
es igual a
std::cout<<"Y= "<<y;
  • Una segunda específica de C++ donde los comentarios comienzan con '//' y terminan con el final de línea. Las líneas del programa podían haberse sustituido por:
//Created by Anjuta version 1.2.4.a
//This file will not be overwritten

Por cierto, el primer comentario nos indica el programa utilizado junto con la versión. El segundo comentario nos dice que este fichero no puede volverse a escribir ¿por qué?
... en efecto, aquí esta main(), y main es la función principal y única, si se sobreescribe habrá dos main dando error el compilador.

Observa que este segundo tipo de comentarios no puede modificar pequeños fragmentos de código.
Código = Variables + Funciones
Indice