2.2.1 Comentarios
Elaborado por Guillermina Jiménez Rasgado
Los comentarios nos permiten documentar los programas o códigos.
A continuación muestro algunas investigaciones realizadas por los estudiantes Alexis Velázquez González y Ulises Navarrete Ruiz
Se le denomina comentario a las palabras que sirven para documentar, explicar o aclarar cómo está hecho el programa.
La documentación de un programa es el conjunto de información interna y externa al programa, que facilitara su posterior mantenimiento y puesta a punto.
La documentación interna es la que se acompaña en el código o programa fuente y se realiza a base de comentarios significativos. Estos comentarios se representan con diferentes notaciones, según el tipo de lenguaje de programación. La documentación externa se acompañará en información ajena al programa y proporcionada por el programador.
Comentario en C++
Ejemplos de comentarios C++ de una sola línea:
// Programa Ecuación segundo grado
// Calcula las soluciones de una ecuación de segundo grado
int p; // precio del producto
Ejemplos de comentarios C++ de varias líneas:
// esto es un comentario en C++
Comienzan con una doble barra ( // ) y se pueden extender hasta el final de la línea.
/* Esto es un comentario
de varias líneas */
Los comentarios son una herramienta proporcionada por un lenguaje de programación que nos ayudará a apoyar la documentación de los programas en C++ y a que sean fácilmente comprendidos por otros. Los comentarios, son líneas de código, que no son tenidas en cuenta por el compilador en el momento de ejecutar nuestra aplicación, por lo tanto, no están sujetas a restricciones de sintaxis ni nada similar, el uso principal de las líneas de comentario, es dar un orden y hacer más entendible nuestro código, especialmente en el caso de que deba en algún momento ser revisado o leido por alguien diferente a nosotros. Por ejemplo, es muy común usar las líneas de comentarios, para dar una breve explicación de cómo funciona cierta parte de un código, lo cual permite identificar todo con mayor rapidez.