Codificación aprenderaprogramar.com: CU00517F
COMENTARIOS EN EL CÓDIGO C
Existen distintas posibilidades para insertar comentarios en el código C como son:
Comentarios en bloque: un comentario en bloque es un fragmento del programa que será ignorado por el compilador y por tanto no será ejecutado como código.
La finalidad de un comentario en bloque es servir de guía o información para una mejor comprensión del programa. El bloque de comentario empieza con el símbolo /* y termina con el símbolo */. Un bloque puede tener la extensión que se desee: una línea, dos líneas, cinco, diez, …, n líneas.
Comentarios en línea: un comentario en línea tiene el mismo objetivo que el comentario en bloque pero su extensión está limitada a una sola línea. El comentario puede encontrarse en una línea independiente o bien en una línea después del código existente en la línea. El comentario empieza con el símbolo // y termina cuando termina la línea, sin que exista un símbolo específico de terminación. Podría suceder que un comentario en bloque ocupara una sola línea. La diferencia con el comentario en línea es que el comentario en bloque tiene que cerrarse obligatoriamente con el símbolo */ mientras que el comentario en línea propiamente dicho no tiene símbolo de cierre.
En un mismo programa pueden aparecer tantos comentarios en bloque o en línea como se estimen oportunos, si bien lo más habitual es situar los comentarios en bloque al comienzo de los ficheros o antes de la declaración de una función para resaltar los aspectos más importantes, mientras que los comentarios en línea suelen situarse en puntos intermedios del código informando sobre distintas cuestiones de interés o que merezcan la pena ser aclaradas.
Los criterios para insertar comentarios son los mismos que se explican para el pseudocódigo en el curso “Bases de la programación nivel I” de aprenderaprogramar.com.
Los comentarios son una parte importante de los programas, por lo que es conveniente cuidar su estructuración y contenidos. Dado que con el pseudocódigo trabajamos con corchetes para introducir comentarios, si se desea podemos usar los corchetes detrás de los símbolos de comentario para "recordar" el carácter de comentario de dicho texto, aunque esto realmente no es necesario.
/* [Esto es un comentario detrás de un símbolo de comentario en bloque. El corchete no es realmente necesario pero podemos ponerlo si queremos] */
Escribe este código en tu editor y comprueba el resultado. Recuerda que los comentarios sirven para documentar, aclarar e informar un programa pero que no tienen ningún efecto en relación a la ejecución del mismo:
|
/** * Esto es un comentario en bloque de varias líneas * Programa para mostrar la edad de una persona * Curso básico de programación aprenderaprogramar.com * Versión: 2055.1.07 * Fecha 04/11/2055 */ #include <stdio.h> #include <stdlib.h> int main() { //Comentario en línea independiente. Declaración de la variable edad int edad; edad=54; //Comentario en línea junto a código. Asignación de valor a la variable edad printf ("La edad es %d\n", edad); printf ("Gracias por utilizar este programa"); /* Finalizamos el programa, comentario en bloque en una sola línea */ return 0; /*Sentencia return de terminación, comentario en bloque en una sola línea*/ } |
EJERCICIO
El siguiente código es un código en lenguaje C. No te preocupes por el código en sí, ya que hay aspectos que todavía no hemos explicado, fíjate únicamente en los comentarios. Responde a las siguientes preguntas:
a) ¿Cuántos comentarios en línea existen en el código?
b) ¿Cuántos comentarios en bloque existen en el código?
Para comprobar si tus respuestas son correctas puedes consultar en los foros aprenderaprogramar.com.
|
//Directivas del preprocesador #include <stdio.h> #include <stdlib.h> /* Fin de las directivas del preprocesador */ /* * Comienzo código */ int main() { //Función principal main int valorUsuario; //Declaración de una variable printf("Introduzca un numero entero: "); //Se muestra mensaje scanf("%d", &valorUsuario); /*Entrada de usuario a variable valorUsuario */ printf("Gracias por introducir un numero"); // Se muestra /*Gracias*/ return 0; /*Fin del programa //return 0 */ } |
Para hacer un comentario o consulta utiliza los foros aprenderaprogramar.com, abiertos a cualquier persona independientemente de su nivel de conocimiento.
