Fundamentos del lenguaje de programación C Parte 3
Comentarios
Los comentarios son líneas o bloques de texto utilizados para documentar la funcionalidad de un programa y explicar cómo funciona un programa en beneficio de un programador. Los comentarios son ignorados por el compilador, por lo que puede escribir todo lo que quiera en ellos.
C admite dos estilos diferentes de comentarios: comentarios de bloque y comentarios de línea única.
Bloquear comentarios
Los comentarios de bloque comienzan con un / * y terminan con un * / y pueden abarcar varias líneas. Por ejemplo:
Las líneas 1-4 comprenden un comentario largo que abarca cuatro líneas. Comienza con el / * al comienzo de la línea 1 y finaliza con el * / al final de la línea 4. El compilador ignora cualquier otro carácter entre esos dos delimitadores.
La línea 7 muestra otro ejemplo donde se usa un comentario de bloque para una sola línea. Mientras que la línea 10 muestra una construcción similar para agregar un comentario al final de una línea de código.
Comentarios de una sola línea
Los comentarios de una sola línea comienzan con // y se ejecutan hasta el final de la línea. A veces se denominan "comentarios de estilo C ++" porque fueron desarrollados para C ++ y originalmente no formaban parte del estándar ANSI C. No pueden abarcar múltiples líneas. Por ejemplo:
Aquí hemos reemplazado cada comentario de bloque del primer ejemplo con una forma equivalente usando un comentario de línea.
Las líneas 1-4 son ahora cuatro comentarios separados con cada línea comenzando con //.
Las líneas 7 y 10 también se convirtieron en comentarios de una sola línea, que son más apropiados para sus situaciones.
Comentarios de anidamiento
Las líneas 1-3 muestran que es perfectamente válido anidar un comentario de una sola línea dentro de un comentario en bloque. De hecho, esta es una práctica muy común cuando se prueban programas. De vez en cuando, es posible que desee eliminar temporalmente un bloque de código de su programa. El uso de delimitadores de comentario de bloque como se muestra aquí tendrá ese efecto siempre que los únicos otros comentarios entre los delimitadores sean comentarios de una sola línea.
Las líneas 5-8 muestran qué puede salir mal cuando los comentarios de bloque están anidados uno dentro del otro. Un comentario comienza con el / * al comienzo de la línea 5. Debido a la línea 5, el delimitador de apertura / * en la línea 6 se ignora por completo, y el delimitador de cierre * / al final de la línea 6 coincide con el delimitador de apertura en línea 5. Esto deja el código en la línea 7 sin comentar, seguido de un comentario completo al final de la línea 7.
Finalmente, al comienzo de la línea 8 tenemos un delimitador de cierre * / que no coincide con un delimitador de apertura, que causará un error de sintaxis.
Mejores prácticas
Idealmente, debería utilizar comentarios de una sola línea en la mayor parte de su código, reservando los comentarios de bloque para los momentos en que desee eliminar temporalmente un bloque de código o para cuando realmente necesite comentarios de varias líneas. A continuación se muestra un ejemplo de cuántos programadores usan los dos estilos de comentarios.
Comentarios
Publicar un comentario