Estructura Básica de un Programa
Comentarios
Difícilmente encontrarás un programa donde no encuentres comentarios, hasta los malos. Los
comentarios son texto que no forma parte del código
fuente
(ni de las directivas del preprocesador). Su objetivo principal es
explicar y documentar el programa.
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, y especialmente cuando el código se escribe por varios autores.
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:
- /******************************************************************
-
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 intermedios 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. Este tipo de comentario
es más rápido de utilizar, pero como inconveniente
tiene
que no permite modificar pequeños fragmentos de
código:
// Todo lo escrito aquí no es código hasta el final de línea.
x=x+y; //el final es comentario, el principio si es código, habitual para comentar líneas.
Un aspecto importante es que el comentario no puede ir entre comillas, pues se considera parte del literal, por ejemplo:
std::cout<<"Hola /*amigo*/Pablo";tendría como salida
Hola /*amigo*/Pablo y no
Hola Pablo, como quizás alguno podría esperar.