Comentar el código es una muy buena práctica para todos y facilitarnos la vida con nuestras aplicaciones. 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 una parte importante de los programas, por lo que es conveniente cuidar su estructuración y contenidos.
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 leído por alguien diferente a nosotros.
Tipos de comentarios en C y C++
Existen principalmente dos formas de declarar comentarios en estos lenguajes, dependiendo de su extensión y propósito:
- Comentarios de una línea (en línea): Tienen el mismo objetivo que el comentario en bloque pero su extensión está limitada a una sola 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.
- Comentarios multi-línea (en bloque): Se utilizan para comentarios más extensos o para desactivar temporalmente bloques de código. Estos comentarios comienzan con /* y terminan con */.
Comparativa de métodos de comentario
| Tipo | Símbolo de inicio | Símbolo de fin |
|---|---|---|
| Una línea | // | Fin de línea |
| Multi-línea | /* | */ |
Reglas y consideraciones importantes
Los comentarios pueden aparecer en cualquier lugar en el que se permita un carácter de espacio en blanco. Es fundamental recordar que la función de los comentarios es aclarar y documentar, no entorpecer el código. En C, los comentarios se delimitan entre /* y */, cualquier cosa que escribamos en su interior será ignorada por el compilador, sólo está prohibido su uso en el interior de palabras reservadas o en el interior de identificadores.
Dado que el compilador trata un comentario como si fuese un único carácter de espacio en blanco, no se pueden incluir comentarios dentro de tokens. Por ejemplo, main(/*Sin argumentos*/void) está permitido, pero ma/*función*/in(void) es ilegal.
Lea también: IVA 21% Excel
Aunque se pueden utilizar comentarios para inhabilitar algunas líneas de código a modo de prueba, las directivas de preprocesador #if y #endif y la compilación condicional son una alternativa útil para esta tarea. Recuerda siempre que el uso principal es dar una breve explicación de cómo funciona cierta parte de un código, lo cual permite identificar todo con mayor rapidez.
Lea también: Guía IVA reducido
Lea también: ¿Cómo localizar tus XML del SAT?
tags: #como #declarar #comentarios #en #c #procedimientos